Wanna see something cool? Check out Angular Spotify 🎧
All Articles

Nx Workspace structure for an application with NestJS and Angular

Original Gist

https://gist.github.com/trungk18/7ef8766cafc05bc8fd87be22de6c5b12

Principles

Below is the sample folder structure for Nx with NestJS and Angular. Our principles are:

  • SCAMs (single component Angular modules) for tree-shakable components, meaning each component will have a respective module. For example, a RegisterComponent will have a corresponding RegisterModule, we won’t declare RegisterComponent as part of AuthModule for example.
  • Mostly everything will stay in the libs folder. New modules, new models, new configurations, new components etc… are in libs. libs should be separated into different directories based on existing apps. We won’t put them inside the apps folder. For example in an Angular, it contains the main.ts, app.component.ts and app.module.ts

Structure

.
└── root
    β”œβ”€β”€ apps
    β”‚   β”œβ”€β”€ api (nestjs)
    β”‚   └── client (angular)
    └── libs (1)
        β”œβ”€β”€ api (dir)
        β”‚   β”œβ”€β”€ core (dir)
        β”‚   β”‚   └── feature (nest:lib) (2)
        β”‚   β”œβ”€β”€ feature-1 (dir)
        β”‚   β”‚   β”œβ”€β”€ data-access (nest:lib, service + entities)
        β”‚   β”‚   β”œβ”€β”€ feature (nest:lib, module + controller)
        β”‚   β”‚   └── utils (nest:lib, things like interceptors, guards, pipes etc...)
        β”‚   └── feature-2 (dir)
        β”‚       β”œβ”€β”€ data-access (nest:lib, service + entities)
        β”‚       β”œβ”€β”€ feature (nest:lib, module + controller)
        β”‚       └── utils (nest:lib, things like interceptors, guards, pipes etc...)
        β”œβ”€β”€ client (dir)
        β”‚   β”œβ”€β”€ shell (dir)
        β”‚   β”‚   └── feature (angular:lib) (3)
        β”‚   └── feature-1 (dir)
        β”‚       β”œβ”€β”€ data-access (angular:lib, service, API calls, state management)
        β”‚       β”œβ”€β”€ feature (4)
        β”‚       β”‚   β”œβ”€β”€ list (angular:lib e.g. ProductList)
        β”‚       β”‚   └── detail (angular:lib e.g. ProductDetail)
        β”‚       β”œβ”€β”€ ui (dir)
        β”‚       β”‚   β”œβ”€β”€ comp-1 (angular:lib, SCAM for Component)
        β”‚       β”‚   └── pipe-1 (angular:lib, SCAM for Pipe)
        β”‚       └── shared (dir)
        β”‚           β”œβ”€β”€ data-access (angular:lib, any Service or State management to share across the Client app)
        β”‚           β”œβ”€β”€ ui (dir, 5)
        β”‚           └── utils (angular:lib, usually shared Guards, Interceptors, Validators...)
        └── shared (dir, most libs in here are buildable @nrwl/angular:lib)
            β”œβ”€β”€ data-access (my shared data-access is usually models, so it is a lib)
            β”œβ”€β”€ ui (optional dir, if I have multiple client apps)
            └── utils (optional dir, usually validation logic or shared utilities)
                β”œβ”€β”€ util1 (lib)
                └── util2 (lib)

(1) lib vs dir

  • a dir is just a directory.
  • a lib is generated by using Nx schematics

(2) api-core-feature: this is the CoreModule that will include all initial setups like Config and Database Connection etc… and importing other Modules. CoreModule will be imported by AppModule

(3) client-shell-feature: Same idea as NestJS’s CoreModule. This Shell includes RouterModule.forRoot()

(4) client-feature-1-feature: This can either a dir or a lib.

  • If this feature only has one Routable component, it is a lib.
  • If it has multiple Routable components, then it should be a dir. For example:
└── feature
    β”œβ”€β”€ list (angular:lib e.g ProductList)
    └── detail (angular:lib e.g. ProductDetail)

feature usually contains the ContainerComponent and the RouterModule.forChild()

(5) client-shared-ui is a little tricky. The general recommendation is to NOT grouped stuffs by type like components, pipes etc… into a single module but because these are shared, it is easy to get quite messy if not grouped by type. This is your call. We prefer to have a Single Component Per Module (SCAM) for each angular library.

This structure is proposed by my friend Chau Tran and I am applying it for my latest project!

Why?

Following the above structure will bring three advantages:

  • Consistency: eliminate mental overhead when we don’t have to think about where to put what in a big repo having from two apps and above.
  • Promote Single Component Per Module (SCAM) + Buildable libraries to get the benefits from the nx affected commands.
  • Prevent circular dependencies issue.

Some rules of thumb

  • data-access: data-access can import other data-access. But never import its feature . For example: user/data-access can import from product/data-access but it will never import from user/feature
  • feature: can only import its own data-access or the global shared/data-access. For example: user/feature can import from user/data-access but never from product/data-access.
  • util: Utils can be shared across data-access, util.
Published 24 Mar 2021

Recent Posts

Convert Promise to Observable

You'll need those tips one day if you get used to RxJS 🀣

TypeScript unknown vs any types

The main difference between unknown and any is that unknown is much less permissive than any: we have to do some form of checking before performing most operations on values of type unknown, whereas we don't have to do any checks before performing operations on values of type any.


Follow @tuantrungvo on Twitter for more!