https://github.com/onetail/simple-twitter-restful
simple twitter style restful api
https://github.com/onetail/simple-twitter-restful
docker-compose eggjs swagger-ui typescript
Last synced: about 2 months ago
JSON representation
simple twitter style restful api
- Host: GitHub
- URL: https://github.com/onetail/simple-twitter-restful
- Owner: Onetail
- Created: 2021-03-14T13:27:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-15T02:18:58.000Z (over 5 years ago)
- Last Synced: 2025-01-24T10:47:03.737Z (over 1 year ago)
- Topics: docker-compose, eggjs, swagger-ui, typescript
- Language: TypeScript
- Homepage:
- Size: 53.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple-twitter-restful
### Development
```bash
$ docker-compose -f docker-compose.local.yml up --build -d
$ npm install
$ npm run build && npm run retest
$ npm run dev
$ open http://localhost:7015/docs
```
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
$ docker-compose up --build -d
```
### 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+