Best scalable project structure #2249

liebalogh · 2019-05-21T23:14:11Z


[ ] Regression 
[ ] Bug report
[X] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

I have big e-commerce apps, i planning move previous codebase from express (Typescript) to NestJS.

After reading documentation and try create nestjs project, I'm confused with project structure. In my opinion generated project structure not scalable, it strange when large codebase have project structure like that.

Currently on my backend have Controller, Model, Event, Middleware, Validator, interface, static file server (subdomain), websocket, here my current project structure

- src
  - app
    - controller
    - model
    - middleware
    - validator
    - event
  - config
    - server.ts
    - route.ts
    - database.ts
    - ...
  - routes
    - sub
      - static.ts
    - store.ts
    - product.ts
    - ...
  - lib
  - main.ts

I'm not angular developer so i dont know how to manage project structure like that

How i for best project structure on awesome nestjs framework ?

The text was updated successfully, but these errors were encountered:

wxs77577 · 2019-05-22T03:00:44Z

Same question: How to organize project structure ？
I need to create a nestjs apis for my frontend UI and backend (admin dashboard) UI, should I create two projects for that or just one (I prefer just one)?
AFAIK, I could use just one project. Each module has both frontend and backend apis. Like this:

nest g mo cats to create cats module.
nest g co cats to create cat apis for frontend.
nest g co cats/admin ( or --flat) to create cat apis for backend.
change @Controller('admin') to @Controller('admin/cats') in admin controller file.

That's all what I think. Hope you could give me some advice, thanks a lot.

liebalogh · 2019-05-22T07:28:39Z

Same question: How to organize project structure ？
I need to create a nestjs apis for my frontend UI and backend (admin dashboard) UI, should I create two projects for that or just one (I prefer just one)?
AFAIK, I could use just one project. Each module has both frontend and backend apis. Like this:

nest g mo cats to create cats module.

nest g co cats to create cat apis for frontend.

nest g co cats/admin ( or --flat) to create cat apis for backend.

change @Controller('admin') to @Controller('admin/cats') in admin controller file.

That's all what I think. Hope you could give me some advice, thanks a lot.

Thanks for you answer,

In my case frontend and backend are not same server, backend on standalone server and my app will consume it. And my question not about frontend and backend in one project but i need know how i manage scalable files and folder structure on my project

wxs77577 · 2019-05-22T07:48:21Z

I think you should follow the official documention: just move to modularize from MVC.
Think all of your resource as modules:

nest g mo users
nest g co users

nest g mo products
nest g co products

...

It will create the right structure for you.

btw, thanks for your comment, maybe I shouldn't put both frontend and backend apis together.

liebalogh · 2019-05-22T08:02:56Z

I think you should follow the official documention: just move to modularize from MVC.
Think all of your resource as modules:
nest g mo users
nest g co users

nest g mo products
nest g co products
...

It will create the right structure for you.

btw, thanks for your comment, maybe I shouldn't put both frontend and backend apis together.

Oh, now i understand. will i move project structure like this

- src
  - modules
    - user
      - user.controller.ts
      - user.model.ts
    - store
      - store.controller.ts
      - store.model.ts
  - middleware
  - interceptor
  - guard

That's right ?

wxs77577 · 2019-05-22T08:05:04Z

That's right, but it seems thers is no modules folder.

kamilmysliwiec · 2019-05-22T09:52:00Z

I need to create a nestjs apis for my frontend UI and backend (admin dashboard) UI, should I create two projects for that or just one (I prefer just one)?

@wxs77577 you can always use monorepo approach - create 2 projects in 1 repo and share common things between them as libraries/packages

@liebalogh without modules directory. Also, you can group common/core things as separate directories + sometimes interceptors/guards/pipes will be scoped by modules. See the following example:

- src
  - core
  - common
    - middleware
    - interceptors
    - guards
  - user
      - interceptors (scoped interceptors)
    - user.controller.ts
    - user.model.ts
  - store
    - store.controller.ts
    - store.model.ts

liebalogh · 2019-05-22T13:29:13Z

I need to create a nestjs apis for my frontend UI and backend (admin dashboard) UI, should I create two projects for that or just one (I prefer just one)?

@wxs77577 you can always use monorepo approach - create 2 projects in 1 repo and share common things between them as libraries/packages

@liebalogh without modules directory. Also, you can group common/core things as separate directories + sometimes interceptors/guards/pipes will be scoped by modules. See the following example:
- src
  - core
  - common
    - middleware
    - interceptors
    - guards
  - user
      - interceptors (scoped interceptors)
    - user.controller.ts
    - user.model.ts
  - store
    - store.controller.ts
    - store.model.ts

I create global interceptor, that will transform object to response template. And What file should on core folder ?

FSM1 · 2019-05-22T17:46:14Z

I need to create a nestjs apis for my frontend UI and backend (admin dashboard) UI, should I create two projects for that or just one (I prefer just one)?

@wxs77577 you can always use monorepo approach - create 2 projects in 1 repo and share common things between them as libraries/packages
@liebalogh without modules directory. Also, you can group common/core things as separate directories + sometimes interceptors/guards/pipes will be scoped by modules. See the following example:
- src
  - core
  - common
    - middleware
    - interceptors
    - guards
  - user
      - interceptors (scoped interceptors)
    - user.controller.ts
    - user.model.ts
  - store
    - store.controller.ts
    - store.model.ts
I create global interceptor, that will transform object to response template. And What file should on core folder ?

Core would be for example where your actual business logic and rules live.

karocksjoelee · 2019-05-24T06:51:38Z

I would like Angular with Nestjs in a same repo, the folder both are src . I am thinking a repo with two folder ?

server-src
- src ( nestjs )
angular-src
- src ( angular )

But this cannot manage same package.json together . Anyone has solution ?

kamilmysliwiec · 2019-05-24T07:09:38Z

@karocksjoelee what about https://www.youtube.com/watch?v=y24fC9Pqr8I

karocksjoelee · 2019-05-24T07:17:06Z

@karocksjoelee what about https://www.youtube.com/watch?v=y24fC9Pqr8I

umm.. looks great , although I am not going with AngularUniversal , cause I don't want SSR .
Good reference of folder structure , thanks man . I will try to put together a starter file for Angular & Nestjs .

sbacem · 2019-05-24T08:51:14Z

@karocksjoelee for big project is better to separate between Api and Frontend

kamilmysliwiec · 2019-05-24T08:58:29Z

@sbacem it depends. Either approach has its own pros and cons honestly

vschoener · 2019-10-28T09:55:17Z

I need to create a nestjs apis for my frontend UI and backend (admin dashboard) UI, should I create two projects for that or just one (I prefer just one)?

@wxs77577 you can always use monorepo approach - create 2 projects in 1 repo and share common things between them as libraries/packages

@liebalogh without modules directory. Also, you can group common/core things as separate directories + sometimes interceptors/guards/pipes will be scoped by modules. See the following example:
- src
  - core
  - common
    - middleware
    - interceptors
    - guards
  - user
      - interceptors (scoped interceptors)
    - user.controller.ts
    - user.model.ts
  - store
    - store.controller.ts
    - store.model.ts

@kamilmysliwiec
I'm just asking myself how to properly architecture the project, so far I create all my module in the src:

- src
   - database
       - database.module.ts
   - logger
   - config
   - users
   - auth
  - shared
     - date-manager.ts
     - shared.module.ts

I'm thinking about moving the database/logger module inside a core module and maybe the Date manager as well but for the last, I'm not sure, I think it's better to let it in a shared module containing helpers for example... But is could also live in the core one,

What do you think? What would be the "best" way to architecture it?

SylvSylv · 2019-11-19T16:50:23Z

I have a question concerning the module's folder structure :

Let's say I have a BasePet module.
Then a Cat module which extends BasePet, but with it's own service and controller,
same for a Dog module which extends BasePet.

Would you suggest to encapsulate even more the module's folders ?

HackPoint · 2020-01-11T17:39:48Z

@kamilmysliwiec
I'm just asking myself how to properly architecture the project, so far I create all my module in the src:
- src
   - database
       - database.module.ts
   - logger
   - config
   - users
   - auth
  - shared
     - date-manager.ts
     - shared.module.ts

If you will use libs, it will be much simple to separate the application logic etc:

auth-lib
shared
- api-lib
  -core
  and so on...

lock · 2020-04-15T07:30:10Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

kamilmysliwiec added the type: question 🙌 label May 22, 2019

kamilmysliwiec closed this as completed May 28, 2019

BrunnerLivio added the needs triage This issue has not been looked into label Aug 8, 2019

lock bot locked as resolved and limited conversation to collaborators Apr 15, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Best scalable project structure #2249

Best scalable project structure #2249

liebalogh commented May 21, 2019 •

edited

wxs77577 commented May 22, 2019

liebalogh commented May 22, 2019

wxs77577 commented May 22, 2019

liebalogh commented May 22, 2019

wxs77577 commented May 22, 2019

kamilmysliwiec commented May 22, 2019

liebalogh commented May 22, 2019 •

edited

FSM1 commented May 22, 2019

karocksjoelee commented May 24, 2019

kamilmysliwiec commented May 24, 2019

karocksjoelee commented May 24, 2019

sbacem commented May 24, 2019

kamilmysliwiec commented May 24, 2019

vschoener commented Oct 28, 2019 •

edited

SylvSylv commented Nov 19, 2019 •

edited

HackPoint commented Jan 11, 2020

lock bot commented Apr 15, 2020

Best scalable project structure #2249

Best scalable project structure #2249

Comments

liebalogh commented May 21, 2019 • edited

wxs77577 commented May 22, 2019

liebalogh commented May 22, 2019

wxs77577 commented May 22, 2019

liebalogh commented May 22, 2019

wxs77577 commented May 22, 2019

kamilmysliwiec commented May 22, 2019

liebalogh commented May 22, 2019 • edited

FSM1 commented May 22, 2019

karocksjoelee commented May 24, 2019

kamilmysliwiec commented May 24, 2019

karocksjoelee commented May 24, 2019

sbacem commented May 24, 2019

kamilmysliwiec commented May 24, 2019

vschoener commented Oct 28, 2019 • edited

SylvSylv commented Nov 19, 2019 • edited

HackPoint commented Jan 11, 2020

lock bot commented Apr 15, 2020

liebalogh commented May 21, 2019 •

edited

liebalogh commented May 22, 2019 •

edited

vschoener commented Oct 28, 2019 •

edited

SylvSylv commented Nov 19, 2019 •

edited