开源软件名称：

unix/koa-ts

开源软件地址：

https://github.com/unix/koa-ts

开源编程语言：

TypeScript 84.2%

开源软件介绍：

koa-ts

The best practice of building Koa2 with TypeScript. 中文

Usage

Run npm init koa-ts
Install dependencies: yarn
Rename .env.example to .env, and run prisma db push to synchronize the data model
Start the server: yarn dev. visit: http://127.0.0.1:3000/apis/sessions

(Optional) the project has built-in a docker compose, run yarn dev:db to run 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
│   ├── constants        ---  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 constants -> 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

When nodejs is running, ENV does not mean NODE_ENV:

After NodeJS project is built, we always run it as NODE_ENV=PRODUCTION, which may affect some framework optimizations.
NODE_ENV only identifies the NodeJS runtime, independent of the business.
You should use ENV to identify the environment.

For the data settings of each environment, you can refer to the following:

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