mirror of
https://github.com/Permissionless-Software-Foundation/x402-base-facilitator.git
synced 2026-09-21 16:52:01 -07:00
Updating README
This commit is contained in:
@@ -2,12 +2,16 @@
|
||||
[](http://standardjs.com)
|
||||
|
||||
Boilerplate for building APIs with [koa2](https://github.com/koajs/koa/tree/v2.x) and mongodb.
|
||||
Modified to remove babel as a dependency. This repository is now natively compatible
|
||||
with node v8.9 or higher.
|
||||
This repository is based on Adrian Obelmejias' [koa-api-boilerplate repository](https://github.com/adrianObel/koa2-api-boilerplate).
|
||||
It makes the following modifications:
|
||||
|
||||
With the exception of removing babel as a dependency, this repository is identical
|
||||
to Adrian Obelmejias' [koa-api-boilerplate repository](https://github.com/adrianObel/koa2-api-boilerplate).
|
||||
- Remove babel as a dependency. This repository is now natively compatible with
|
||||
node v8.9 or higher.
|
||||
|
||||
- Replaced `bcrypt` dependency with `bcryptjs`. This improves compatibility across
|
||||
versions of node.js and across OSs.
|
||||
|
||||
## Features
|
||||
This project covers basic necessities of most APIs.
|
||||
* Authentication (passport & jwt)
|
||||
* Database (mongoose)
|
||||
@@ -15,6 +19,8 @@ This project covers basic necessities of most APIs.
|
||||
* Doc generation with apidoc
|
||||
* linting using standard
|
||||
|
||||
|
||||
|
||||
## Requirements
|
||||
* node __^8.9.4__
|
||||
* npm __^5.7.1__
|
||||
@@ -24,20 +30,6 @@ This project covers basic necessities of most APIs.
|
||||
git clone https://github.com/christroutner/babel-free-koa2-api-boilerplate.git
|
||||
```
|
||||
|
||||
## Features
|
||||
* [koa2](https://github.com/koajs/koa/tree/v2.x)
|
||||
* [koa-router](https://github.com/alexmingoia/koa-router)
|
||||
* [koa-bodyparser](https://github.com/koajs/bodyparser)
|
||||
* [koa-generic-session](https://github.com/koajs/generic-session)
|
||||
* [koa-logger](https://github.com/koajs/logger)
|
||||
* [MongoDB](http://mongodb.org/)
|
||||
* [Mongoose](http://mongoosejs.com/)
|
||||
* [Passport](http://passportjs.org/)
|
||||
* [Nodemon](http://nodemon.io/)
|
||||
* [Mocha](https://mochajs.org/)
|
||||
* [apidoc](http://apidocjs.com/)
|
||||
* [ESLint](http://eslint.org/)
|
||||
|
||||
## Structure
|
||||
```
|
||||
├── bin
|
||||
@@ -71,5 +63,20 @@ API documentation is written inline and generated by [apidoc](http://apidocjs.co
|
||||
|
||||
Visit `http://localhost:5000/docs/` to view docs
|
||||
|
||||
|
||||
## Dependencies
|
||||
* [koa2](https://github.com/koajs/koa/tree/v2.x)
|
||||
* [koa-router](https://github.com/alexmingoia/koa-router)
|
||||
* [koa-bodyparser](https://github.com/koajs/bodyparser)
|
||||
* [koa-generic-session](https://github.com/koajs/generic-session)
|
||||
* [koa-logger](https://github.com/koajs/logger)
|
||||
* [MongoDB](http://mongodb.org/)
|
||||
* [Mongoose](http://mongoosejs.com/)
|
||||
* [Passport](http://passportjs.org/)
|
||||
* [Nodemon](http://nodemon.io/)
|
||||
* [Mocha](https://mochajs.org/)
|
||||
* [apidoc](http://apidocjs.com/)
|
||||
* [ESLint](http://eslint.org/)
|
||||
|
||||
## License
|
||||
MIT
|
||||
|
||||
Reference in New Issue
Block a user