Skip to content

Commit 8942dd1

Browse files
author
hirsch88
committed
Add requests and response folders to the app structure
1 parent 6ff19fc commit 8942dd1

File tree

3 files changed

+31
-29
lines changed

3 files changed

+31
-29
lines changed

README.md

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -170,35 +170,37 @@ The swagger and the monitor route can be altered in the `.env` file.
170170

171171
## Project Structure
172172

173-
| Name | Description |
174-
| ----------------------------- | ----------- |
175-
| **.vscode/** | VSCode tasks, launch configuration and some other settings |
176-
| **dist/** | Compiled source files will be placed here |
177-
| **src/** | Source files |
178-
| **src/api/controllers/** | REST API Controllers |
179-
| **src/api/errors/** | Custom HttpErrors like 404 NotFound |
180-
| **src/api/interceptors/** | Interceptors are used to change or replace the data returned to the client. |
181-
| **src/api/middlewares/** | Express Middlewares like helmet security features |
182-
| **src/api/models/** | Bookshelf Models |
183-
| **src/api/repositories/** | Repository / DB layer |
184-
| **src/api/services/** | Service layer |
185-
| **src/api/subscribers/** | Event subscribers |
186-
| **src/api/validators/** | Custom validators, which can be used in the request classes |
187-
| **src/api/** swagger.json | Swagger documentation |
188-
| **src/auth/** | Authentication checkers and services |
189-
| **src/core/** | The core features like logger and env variables |
190-
| **src/database/factories** | Factory the generate fake entities |
191-
| **src/database/migrations** | Database migration scripts |
192-
| **src/database/seeds** | Seeds to create some data in the database |
193-
| **src/decorators/** | Custom decorators like @Logger & @EventDispatch |
194-
| **src/loaders/** | Loader is a place where you can configure your app |
195-
| **src/public/** | Static assets (fonts, css, js, img). |
196-
| **src/types/** *.d.ts | Custom type definitions and files that aren't on DefinitelyTyped |
197-
| **test** | Tests |
198-
| **test/e2e/** *.test.ts | End-2-End tests (like e2e) |
199-
| **test/unit/** *.test.ts | Unit tests |
200-
| .env.example | Environment configurations |
201-
| ormconfig.json | TypeORM configuration for the database. Used by seeds and the migration. (generated file) |
173+
| Name | Description |
174+
| --------------------------------- | ----------- |
175+
| **.vscode/** | VSCode tasks, launch configuration and some other settings |
176+
| **dist/** | Compiled source files will be placed here |
177+
| **src/** | Source files |
178+
| **src/api/controllers/** | REST API Controllers |
179+
| **src/api/controllers/requests** | Request classes with validation rules if the body is not equal with a model |
180+
| **src/api/controllers/responses** | Response classes or interfaces to type json response bodies |
181+
| **src/api/errors/** | Custom HttpErrors like 404 NotFound |
182+
| **src/api/interceptors/** | Interceptors are used to change or replace the data returned to the client. |
183+
| **src/api/middlewares/** | Express Middlewares like helmet security features |
184+
| **src/api/models/** | Bookshelf Models |
185+
| **src/api/repositories/** | Repository / DB layer |
186+
| **src/api/services/** | Service layer |
187+
| **src/api/subscribers/** | Event subscribers |
188+
| **src/api/validators/** | Custom validators, which can be used in the request classes |
189+
| **src/api/** swagger.json | Swagger documentation |
190+
| **src/auth/** | Authentication checkers and services |
191+
| **src/core/** | The core features like logger and env variables |
192+
| **src/database/factories** | Factory the generate fake entities |
193+
| **src/database/migrations** | Database migration scripts |
194+
| **src/database/seeds** | Seeds to create some data in the database |
195+
| **src/decorators/** | Custom decorators like @Logger & @EventDispatch |
196+
| **src/loaders/** | Loader is a place where you can configure your app |
197+
| **src/public/** | Static assets (fonts, css, js, img). |
198+
| **src/types/** *.d.ts | Custom type definitions and files that aren't on DefinitelyTyped |
199+
| **test** | Tests |
200+
| **test/e2e/** *.test.ts | End-2-End tests (like e2e) |
201+
| **test/unit/** *.test.ts | Unit tests |
202+
| .env.example | Environment configurations |
203+
| ormconfig.json | TypeORM configuration for the database. Used by seeds and the migration. (generated file) |
202204

203205
## Logging
204206

src/api/controllers/requests/.gitkeep

Whitespace-only changes.

src/api/controllers/responses/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)