pehlaj-rai-10p/koa2-typeorm-boilerplate

Koa2 TS Boilerplate with typeorm

KOA TS Quickstart

A simple koa ts quickstarter

Documentation

Prerequisites

1. docker and docker compose (lastest version) Docker & Docker-Compose

commands to get you started

1. git clone https://github.com/mowaiskalam/koa2-typeorm-boilerplate.git and go to project folder.
2. create .env file in config directory
3. npm install (install packages locally, since we don't mount node_modules in container)
4. npm run build:docker
5. npm run start:docker

A collection of useful commands which might be helpful

Logs

1. npm run logs

Linting / Code prettify

1. npm run lint
2. npm run lint:fix
3. npm run format:check
4. npm run format:fix:all

Run tests

1. npm run test

Debug

1. uncomment following line from docker-compose.yml

#- --inspect-brk=0.0.0.0

2. create launch.json in .vscode folder, and copy following code

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "attach",
      "name": "Docker: Attach to Node",
      "port": 9229,
      "address": "localhost",
      "localRoot": "${workspaceFolder}/src",
      "remoteRoot": "/api/src",
      "protocol": "inspector"
    }
  ]
}

Sample .env

NODE_ENV=local
PORT=4001
CONN_NAME=default
TYPEORM_CONNECTION=postgres
TYPEORM_HOST=postgres
TYPEORM_USERNAME=postgres
TYPEORM_PASSWORD=postgres
TYPEORM_DATABASE=nodejs101
TYPEORM_PORT=5432
TYPEORM_ENTITIES=src/entities/**/*.ts
TYPEORM_MIGRATIONS=database/migrations/**/*.ts
TYPEORM_ENTITIES_DIR=src/entities
TYPEORM_MIGRATIONS_DIR=database/migrations
TYPEORM_DRIVER_EXTRA={"max":100}