Skip to content

Suite Framework Central Documentation Hub

The ITsynch Suite Framework is the evolution of the ITsynch Core Software Development Kits. With the pursuit of standardization, in code and UI/UX the concept of SDKs or libraries are not enough. Libraries are tools for you to build your application; a Framework forces and limits you, guiding you in the right (or desired) direction.

Thus, the Suite Framework provides everything you need to build your application, including boundaries that help us maintain standardization across the suite. The main idea, is that you can purely focus on building your business logic and rely on the Suite Framework to do the rest.

Primarily, the Suite Framework is composed by:

  • .Net packages for building HTTP services using .NET
  • Angular Modules for building web clients which are tied to "the suite standards"
  • The Suite's UI Framework, a wrapper of Angular Material and other modules.
  • Integration with the Suite's Core Services
  • Components, pieces, tools, and utilities to build most features of your apps, this includes server side stuff like searching, custom fields, etc. and the Suite's UI Framework based on Angular Material.

Fundamentals

  1. No exceptions: There's no difference between an Inspection Service or a Users Service. They're both built using the same framework and tools. They both help compose the suite as whole unit.

  2. Boundaries: There will be hard limits on what can be done, which shall be re-evaluated if needed, but please note, this is by design. We don't want to build extension points for everything we do, since we want to avoid customization. We want standardization and for that extensibility must be punished.

Let's review a bit how the project is structured

  1. angular/ an NX workspace which includes libraries, like the Suite Framework and applications like the Administration Portal.
  2. dotnet/
    1. framework/ the building blocks for our Suite Modules and Apps.
    2. modules/ modules that are intended to be installed on applications, also called "client-side" or App.Modules for their namespace. These compose the framework, and are mostly developed by the Suite Team.
    3. runtime/ includes what is needed to compose and execute an application using Suite Modules.
    4. services/ contains grouping folders per Bounded Context, which includes one or multiple executables which are the services that compose the Suite 3.0

You can read more of the structure of each project in their corresponding documentation page