Skip to content

Commit

Permalink
docs: update backend docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AlasDiablo committed Aug 21, 2024
1 parent 11d1cb3 commit 1adb30d
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions tdm-be/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,21 @@ The server will start running at `http://localhost:3000` (or the port specified

The project structure is organized as follows:

- `config/`: Contains application config files
- `crash/`: Contains crash reports.
- `logs/`: Contains logs.
- `public/`: Contains serv HTML and files.
- `tmp/`: Contains temporary files.
- `upload/`: Contains uploaded files.
- `src/`: Contains the source code of the Express application.
- `routers/`: Contains route definitions for different endpoints.
- `controller/`: Contains route definitions for different endpoints.
- `model/`: Defines data models or interacts with the database.
- `services/`: Custom services here we have only one to send mail.
- `app.ts`: Entry point of the application.
- `config.json`: Configuration file of the application.
- `swagger.ts`: script to generate swagger files.
- `lib/`: Contains utility fonction.
- `templates/`: Contains email template.
- `worker/`: Contains processing fonction.
- `app.ts`: Entry point of the application.

## Available Scripts

- `npm run start`: Start the server in production mode.
- `npm run swagger-autogen`: To generate swagger for config route (swagger-config.json) and for front end application (swagger.json).
- `npm run swagger-autogen`: To generate swagger for config route (swagger-config.json) and for front end application (swagger.json).

0 comments on commit 1adb30d

Please sign in to comment.