# egg-ts-template

**Repository Path**: lc23333/egg-ts-template

## Basic Information

- **Project Name**: egg-ts-template
- **Description**: No description available
- **Primary Language**: NodeJS
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-01-07
- **Last Updated**: 2022-03-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Nodejs, TypeScript

## README


## QuickStart

### Config
运行前需要创建并填写正确的配置 请遵循config.{env}.ts格式命名
```
eggts/config/config.default.ts // 默认配置
eggts/config/config.local.ts // 本地配置
eggts/config/config.prod.ts // 生产配置
```
### Development
```bash
$ npm i
$ npm run dev
$ open http://localhost:7001/
```

Don't tsc compile at development mode, if you had run `tsc` then you need to `npm run clean` before `npm run dev`.

### Deploy

```bash
$ npm run tsc
$ npm start
```

### Npm Scripts

- Use `npm run lint` to check code style
- Use `npm test` to run unit test
- se `npm run clean` to clean compiled js at development mode once

### Requirement

- Node.js 8.x
- Typescript 2.8+

## 主要技术栈
```
nodejs, egg, typescript, sequelize(ORM框架) redis
```