Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbalas/koalerplate
Simple Koa Boilerplate for APIs
https://github.com/dbalas/koalerplate
boilerplate javascript koa koa2 nodejs
Last synced: about 1 month ago
JSON representation
Simple Koa Boilerplate for APIs
- Host: GitHub
- URL: https://github.com/dbalas/koalerplate
- Owner: dbalas
- License: mit
- Created: 2017-10-24T12:08:16.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-07-01T04:50:17.000Z (over 3 years ago)
- Last Synced: 2024-10-29T12:57:31.336Z (about 1 month ago)
- Topics: boilerplate, javascript, koa, koa2, nodejs
- Language: JavaScript
- Size: 382 KB
- Stars: 124
- Watchers: 5
- Forks: 26
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: history.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-koa - koalerplate - 一个简单的使用 ES6 de Koa 2 样板。 ![](https://img.shields.io/github/stars/dbalas/koalerplate.svg?style=social&label=Star) (仓库 / 案例 & 样板程序)
- awesome-koa - koalerplate - A simple Koa 2 boilerplate for API's using ES6. (Examples & Boilerplates)
README
# Koalerplate
A simple Koa 2 boilerplate for API's using ES6.
[![GitHub issues](https://img.shields.io/github/issues/dbalas/koalerplate.svg?style=flat-square)](https://github.com/dbalas/koalerplate/issues)
[![GitHub stars](https://img.shields.io/github/stars/dbalas/koalerplate.svg?style=flat-square)](https://github.com/dbalas/koalerplate/stargazers)
[![GitHub license](https://img.shields.io/github/license/dbalas/koalerplate.svg?style=flat-square)](https://github.com/dbalas/koalerplate/blob/master/LICENSE.md)## What's in the package?
* Routing with koa-router.
* Parsing request with koa-bodyparser.
* CORS middleware with @koa/cors.
* koa-respond for helper functions on the context.
* koa-helmet for important security headers.
* nodemon for development to auto-restart when your files change.
* dotenv for environment variable management.## Getting Started
```
git clone https://github.com/dbalas/koalerplate.git
cd koalerplate
mv .env.sample .env
npm run dev // or yarn dev
```By default the API server starts on port 3000, http://localhost:3000.
### Prerequisites
* node >= v7.6.0
## Contributing
Feel free to submit pull request or suggestions [here](https://github.com/dbalas/koalerplate/issues/new)
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/dbalas/koalerplate/tags).
## Authors
* **Daniel Balastegui** - *Initial work* - [dbalas](https://github.com/dbalas)
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details