atulord/koa-ts

koa-ts

The best practice of building Koa2 with TypeScript. 中文

v3.1 UPDATE: We used Prisma instead of typeorm, reduced runtime memory requirements to half that of the previous version.

Usage

This layout requires NodeJS v12+

Run npm init koa-ts.
Install dependencies: yarn or npm i.
Run prisma migrate dev to synchronize the data model.
Start the server: yarn dev or npm dev. visit: http://127.0.0.1:3000/apis/sessions

(Optional) the project has built-in a docker-compose, run npm run compose lift database automatic.

Project Layout

├── app
│   ├── controllers         ---  server controllers
│   ├── helpers             ---  helper func (interceptor / error handler / validator...)
│   ├── jobs                ---  task (periodic task / trigger task / email server...)
│   ├── entities            ---  database entities/models
│   └── services            ---  adhesive controller and model
├── config
│   ├── environments        ---  environment variable
│   ├── koa.middlewares     ---  middlewares for Koa
│   ├── routing.middlewares ---  middlewares for Routing Controller
│   ├── routing.options     ---  configs for Routing Controller
│   ├── bootstrap           ---  lifecycle
│   └── interceptors        ---  global interceptor
│   └── utils               ---  pure functions for help
└── test                    ---  utils for testcase
├── .env           ---  environment file

Feature

Separation configuration and business logic.
Export scheme model and interface, follow style of TypeScript.
Test cases and lint configuration.
The best practice for Dependency Injection in Koa project.
Get constraints on your data model with Prisma.
TypeScript hotload.

Lifecycle

app.ts -> collect env vars environments -> collect env files variables.env
envs ready, call bootstrap.before()
lift routing-controllers -> lift Koa middlewares -> register Container for DI
start Koa & invoke bootstrap.after() after startup

Databases

The project uses Prisma as the intelligent ORM tool by default. Supports PostgreSQL, MySQL and SQLite.

You can change the data type and connection method in the .env file
After each modification to file /prisma/schema.prisma, you need to run prisma migrate dev to migrate the database.
After each modification to file /prisma/schema.prisma, you need to run prisma generate to sync types.

About Environments

Development Mode (NODE_ENV=development): read configurations from configs/environments/development.ts file, but it will still be overwritten by .env file.
Production Mode (NODE_ENV=production): read configurations from configs/environments/production.ts file, but it will still be overwritten by .env file.

Reference

LICENSE

This project is licensed under the MIT License. See the LICENSE file for more info.

atulord / koa-ts