https://github.com/robertoachar/playground-koa-swagger
A playground for Koa and Swagger
https://github.com/robertoachar/playground-koa-swagger
Last synced: about 1 year ago
JSON representation
A playground for Koa and Swagger
- Host: GitHub
- URL: https://github.com/robertoachar/playground-koa-swagger
- Owner: robertoachar
- License: mit
- Created: 2022-10-13T17:29:06.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-13T21:24:23.000Z (almost 4 years ago)
- Last Synced: 2025-02-17T10:21:50.445Z (over 1 year ago)
- Language: JavaScript
- Size: 175 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# playground-koa-swagger
Generated by [Node Project Generator](https://github.com/robertoachar/generator-node).
[![License][license-badge]][license-url]
> A playground for Koa and Swagger
## Development
- Clone the repo
```bash
$ git clone https://github.com/robertoachar/playground-koa-swagger.git
```
- Install dependencies
```bash
$ npm install
```
- Run scripts
| Action | Usage (npm) | Usage (yarn) |
| ----------------------------------- | ----------------------- | -------------------- |
| Start development mode | `npm start` | `yarn start |
| Build docs | `npm run docs` | `yarn docs |
| Run lint | `npm run lint` | `yarn lint` |
| Start lint in watch mode | `npm run lint:watch` | `yarn lint:watch` |
| Run tests | `npm run jest` | `yarn jest` |
| Start tests in watch mode | `npm run jest:watch` | `yarn jest:watch` |
| Run tests with code coverage | `npm run jest:coverage` | `yarn jest:coverage` |
| Run lint + tests | `npm test` | `yarn test` |
| Start lint + tests in watch mode | `npm test:watch` | `yarn test:watch` |
| Run lint + tests with code coverage | `npm test:coverage` | `yarn test:coverage` |
- Browse to: https://localhost:3000/docs
## Author
[Roberto Achar](https://twitter.com/robertoachar)
## License
[MIT](https://github.com/robertoachar/playground-koa-swagger/blob/master/LICENSE)
[license-badge]: https://img.shields.io/github/license/robertoachar/playground-koa-swagger.svg
[license-url]: https://opensource.org/licenses/MIT