Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Boilerplate for building APIs with koa2.

License

NotificationsYou must be signed in to change notification settings

adrianObel/koa2-api-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#koa2-api-boilerplatejs-standard-style

Boilerplate for building APIs withkoa2 and mongodb.

This project covers basic necessities of most APIs.

  • Authentication (passport & jwt)
  • Database (mongoose)
  • Testing (mocha)
  • Doc generation with apidoc
  • linting using standard

##Requirements

  • node^4.0.0
  • npm^3.0.0

##Installation

git clone https://github.com/adrianObel/koa2-api-boilerplate.git

##Features

##Structure

├── bin│   └── server.js            # Bootstrapping and entry point├── config                   # Server configuration settings│   ├── env                  # Environment specific config│   │   ├── common.js│   │   ├── development.js│   │   ├── production.js│   │   └── test.js│   ├── index.js             # Config entrypoint - exports config according to envionrment and commons│   └── passport.js          # Passportjs config of strategies├── src                      # Source code│   ├── modules│   │   ├── controller.js    # Module-specific controllers│   │   └── router.js        # Router definitions for module│   ├── models               # Mongoose models│   └── middleware           # Custom middleware│       └── validators       # Validation middleware└── test                     # Unit tests

##Usage

  • npm start Start server on live mode
  • npm run dev Start server on dev mode with nodemon
  • npm run docs Generate API documentation
  • npm test Run mocha tests

##DocumentationAPI documentation is written inline and generated byapidoc.

Visithttp://localhost:5000/docs/ to view docs

##LicenseMIT

About

Boilerplate for building APIs with koa2.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors5


[8]ページ先頭

©2009-2025 Movatter.jp