https://github.com/xskytech/koa-api
Flexible Koa API
https://github.com/xskytech/koa-api
api boilerplate koa rest
Last synced: 2 months ago
JSON representation
Flexible Koa API
- Host: GitHub
- URL: https://github.com/xskytech/koa-api
- Owner: xskytech
- License: mit
- Created: 2019-06-09T15:58:16.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T11:34:56.000Z (over 3 years ago)
- Last Synced: 2025-10-09T00:49:37.473Z (8 months ago)
- Topics: api, boilerplate, koa, rest
- Language: JavaScript
- Size: 1.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Koa API
## Flexible Koa API
### Development
```bash
git clone git@github.com:xskytech/koa-api.git
cd koa-api
```
### Installation
**npm version >= 5.2.0**
```bash
npx @xskytech/create-koa-api koa-api
```
**npm version < 5.2.0**
```bash
npm install --global @xskytech/create-koa-api
@xskytech/create-koa-api koa-api
```
### Configuration
**Change directory**
```bash
cd koa-api
```
**Copy .env.example to .env and change data**
```bash
cp .env.example .env
```
### Linting
**Check lint issues**
```bash
npm run lint
```
**Fix lint issues**
```bash
npm run lint:fix
```
### Validate
**Validate application**
```bash
npm run validate
```
### Migrate
**Create DB**
```bash
npm run database:create
```
**Run migrations**
```bash
npm run database:migrate:up
```
**Undo migrations**
```bash
npm run database:migrate:down
```
**Run seeds**
```bash
npm run database:seed:up
```
**Undo seeds**
```bash
npm run database:seed:down
```
**Drop DB**
```bash
npm run database:drop
```
### Run
**Run in development**
```bash
npm run develop
```
**Run in production**
```bash
npm start
```
### License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.