SETUP AND RUN

Recommended Node version: Node 12.x, Node 14.x

A. Setup

1. Create .env file from .env.sample file

2. Install dependencies

npm install --save

3. (Optional) Install Rest Client plugin in Visual Studio Code

B. Run Application

npm start

C. Run Eslint

npm run check

D. Run unit test

npm run test

RUN WITH DOCKER

1. Create .env file from .env.sample file

2. Install dependencies

npm install --save

3. Install Docker

4. Install docker-compose

5. Edit ormconfig.ts

export default {
    type: "mysql",
    host: "mysql", <mysql service name or server IP>
    port: 3306,
    username: "your_username",
    password: "your_password",
    database: "nodejs_db",
    logging: false,
    synchronize: true,
    migrations: ["src/migrations/*.{ts,js}"],
    cli: {
        "migrationsDir": "src/migrations"
    },
    namingStrategy: new CustomNamingStrategy()
};

6. Build docker image and run docker-compose

docker-compose up -d --build

PROJECT STRUCTURE

• .env : Setting enviroment
• .eslintrc : Setting eslint
• .prettierrc : Setting format code
• .eslintignore : Setting ignore cho eslint
• src
  • index.ts
  • ApiServer.ts : Setup server như Controller, Entities, CORS, Cron job,...
  • bo : Bussiness Object
    • entities : Chứa các class Entity
    • models : Chứa các class / interface khác (như Request, Response interface)
  • consts : Chứa các file khai báo kiểu Const hoặc Enum
  • controllers : Chứa các controller
    • index.ts : export tất cả các controller
  • exceptions : Định nghĩa các loại exception
    • AppException.ts : Exception của app, HttpStatusCode = 400
    • HttpException.ts : Các exception khác, HttpStatusCode mặc định là 500
  • middleware : Khai báo các middleware
    • checkJwt.middleware.ts : Check xem request có gửi token hợp lệ lên không, nếu không trả về HttpStatusCode=401
    • checkRole.middleware.ts : Check xem request có quyền truy cập hay không, nếu không trả về HttpStatusCode=401
  • repositories : Khai báo các repository
  • services : Khai báo các service
  • utils : Khai báo các class được sử dụng thường xuyên
    • Log.ts : Log util