# Koa-Web + TypeScript

This template-mini should help get you started developing with koa2 and TypeScript in koa-web.

## Usage

> If you are not using the `pnpm` tool, using `npm` and `yarn` are the same to achieve the same performance.

1. install dependencies

   ```
   $ pnpm install
   ```

2. start app

   ```dev
   $ pnpm dev
   # please open in: http://127.0.0.1:3100/api/doc.html
   ```

3. build project

   ```
   $ pnpm build
   ```

4. run build

   ```
   $ pnpm serve
   ```

## Project Layout

template-mini

```
├── dist                   // build output
├── src
│   ├── app.ts              // koa start
│   ├── app                 // app modules
│   ├── config              // env config
│   ├── typings             // global types
│   └── core                // core mudules
│       ├── init.ts         // core start
│       ├── global.ts       // global var
│       ├── tool.ts         // tool
│       ├── exception       // global exception
│       └── swagger         // api docs and validator
├── .gitignore
├── nodemon.json
├── package.json
├── README.md
└── tsconfig.json
```