Skip to content

README.md

Latest commit

 

History

History
82 lines (56 loc) · 1.29 KB

README.md

File metadata and controls

82 lines (56 loc) · 1.29 KB

koa-ts-base-template

This is a basic of koa project structure, integrated with ts.

Features

✓ koa v2

✓ Typescript

✓ Jest

✓ APIDOC

✓ Docker

✓ Eslint

✓ Husky

Installation CLI

 npm i -g koa-ts-cli

Create Project

 koats create myProject
 # Choose koa-ts-base-template option.
 
 cd myProject
 npm install

In Development Mode

 cd myProject
 npm run dev

In Porduction Mode

 npm run build
 cd myProject/dist
 npm run prod

Run In Docker

 cd myProject
 npm install
 npm run build
 sudo docker build -t koa-ts-api-server .
 sudo docker run -it --name koa-ts-api-server -p 8080:8080 koa-ts-api-server

or

 cd myProject
 ./docker-build.sh
 sudo docker run -it --name koa-ts-api-server -p 8080:8080 koa-ts-api-server

Test

Unit test can be used to ensure the quality of the code.

 cd myProject
 npm run test

Generate Apidoc

 npm run apidoc