README.md

Market Depth API

Requirements

• pnpm
• nodejs >= 16.15.1

Folder Structure

dist                         // build
src
    api
       moduleAPI
            *.controller.ts
            *.router.ts
            *.service.ts
    core                    // platform share
        config.ts           // environment variables
        decorators.ts       // utils decorator
        apiError.ts         // to handle custom error with specified code status in response
        logging.ts          // custom logger
        types.ts            // custom types
    services                // Share services/Share business requirements
        *.service.ts
    app.ts
    index.ts

__test__ folder for unit test

Features

• Packages manager with pnpm
• Swagger call app.setupSwagger(config) to enable
• Logger API with morgan
• Custom validation and error handle API @ValidateController() with zod
• Testing with jest
• Eslint
• Hot reload nodemon

Run test

• Create .env.test
• run pnpm test or pnpm test:watch