Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/transitive-bullshit/koa-api-boilerplate

Koa 2 API boilerplate with batteries-included.
https://github.com/transitive-bullshit/koa-api-boilerplate

api boilerplate koa koa2 mongodb mongoose

Last synced: 20 days ago
JSON representation

Koa 2 API boilerplate with batteries-included.

Host: GitHub
URL: https://github.com/transitive-bullshit/koa-api-boilerplate
Owner: transitive-bullshit
Created: 2018-04-18T00:58:46.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2020-07-11T23:11:33.000Z (over 4 years ago)
Last Synced: 2024-10-20T01:09:34.038Z (26 days ago)
Topics: api, boilerplate, koa, koa2, mongodb, mongoose
Language: JavaScript
Size: 80.1 KB
Stars: 3
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

        # koa-api-boilerplate

> [Koa 2](http://koajs.com/) API boilerplate with batteries-included.

[![NPM](https://img.shields.io/npm/v/koa-api-boilerplate.svg)](https://www.npmjs.com/package/koa-api-boilerplate) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Features

- [koa-micro](https://github.com/transitive-bullshit/koa-micro) - microservices with batteries included

  - Koa 2 app

  - Common context utilities

  - Common middleware like error handling, response time, CORS, auth, etc

  - Logger supporting [Google Cloud Trace](https://cloud.google.com/trace/)

  - Error handler middleware with [Google Cloud Errors](https://cloud.google.com/error-reporting/)

  - Health check endpoint (`/alive` by default)

- [koa2-mongoose-crud](https://github.com/transitive-bullshit/koa2-mongoose-crud) - CRUD middleware for Mongoose models

  - Quickly create RESTful APIs over mongodb models

## Todo

- jwt authentication

- acl authorization

- github / facebook / twitter oauth flows

- redo mongoose base model and revisit safePaths stuff

- revisit db abstraction

- accompanying frontend CRA boilerplate

- user signup / signin / signout / reset password flows

## License

MIT © [Travis Fischer](https://github.com/transitive-bullshit)

Support my OSS work by following me on twitter