Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
HendryZheng committed Jul 16, 2023
1 parent 50fe6e4 commit e2b3ad3
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions backend/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,20 @@ npm install
## Database Table
![Database Schme](./docs/ERD.jpg)

## Project Structure
- src/ # Main source parent folder
- controllers/ # Route controllers
- libs/ # Reusable libraries
- middlewares/ # Express middlewares
- services/ # Business logic and Data Fetching
- typeorm/ # TypeORM config
- workers/ # Background workers
- app.ts # Express app
- config.ts # Environment variables
- connect.ts # Database connection
- data-source.ts # TypeORM data source
- init.ts # App initialization
- server.ts # HTTP server start

### Docker Configuration

Expand Down Expand Up @@ -79,5 +93,14 @@ docker-compose up
npm run migration:run
```

This will start the backend application on port 3006.
This will start the backend application on port 3000;

### Built With
- (Node.js)[https://nodejs.org/]
- (Express)[https://expressjs.com/]
- (TypeScript)[https://www.typescriptlang.org/]
- (TypeORM)[https://typeorm.io/]
- (PostgreSQL)[https://www.postgresql.org/]
## Authors

- [HendryZheng](https://github.com/xen-HendryZheng)

0 comments on commit e2b3ad3

Please sign in to comment.