Boilerplate API

Main modules

• awilix
• mali
• typeorm

Playing locally

• NodeJS >= 12.x.x
• Docker Image
• .env file

Ready

Run the npm install command

$ npm install

Copy the .env.sample file to ./.env

$ cp .env.sample ./.env

Running with docker

Build the docker image

$ docker build -t user-api:latest .

Run the docker container

$ docker-compose up -f docker-compose.yml

Running with Local

Run the command as below

# lint
$ npm run lint

# type check
$ npm run type-check

# start
$ npm start

Project structure

src
├── common
│   ├── config
│   ├── types
│   └── utils
├── data
├── domain
│   ├── entity
│   └── usecase
├── infrastructure
│   ├── grpc-caller
│   ├── mali
│   └── typeorm
└── web
│   ├── grpc
│   └── request
test
├── integration
│   └── grpc
└── unit
    ├── data
    └── domain