gfa

generator-full-api

api generator

Showing:

Popularity

Downloads/wk

9

GitHub Stars

1

Maintenance

Last Commit

5yrs ago

Contributors

1

Package

Dependencies

3

License

ISC

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Yeoman generator for an API backend.

Getting started

To install the Full Api Generator, simply run

npm install -g generator-full-api

To create a new project run the following command

yo full-api <project name>

options

  • --nr : create a new project without a HelloWorld resource

If you don't provide a project name, you will be prompted for it in the next step

Resources

To create a new resource, execute

yo full-api:resource <resource name>

If you don't provide a resource name, you will be prompted for it in the next step

options

  • --nr : create a new resource without a routes file
  • --nc : create a new resource without a controller
  • --nd : create a new resource without a DAO class
  • --nm : create a new resource without a model
  • --nt : create a new resource without a test file
  • --nh : create a new resource without a helper file
  • --nrm : create a new resource without a README file
  • --routes : boolean. Sets whether this resource must contain a routes file or not
  • --controller : boolean. Sets whether this resource must contain a controller or not
  • --dao : boolean. Sets whether this resource must contain a DAO class or not
  • --model : boolean. Sets whether this resource must contain a model or not
  • --test : boolean. Sets whether this resource must contain a test file or not
  • --helper : boolean. Sets whether this resource must contain a helper file
  • --readme : boolean. Sets whether this resource must contain a README file or not

Content

The application is currently bound with the following stack:

  • ExpressJS : as the webserver
  • BluebirdJS : as the Promise library
  • Mongoose : as the ODM tool for handling MongoDB
  • Nodemon : as a Node refresher (restarts the application every time it's modified)
  • PM2 : as a process manager, to keep the application alive in production
  • Bunyan : as a logging library
  • Mocha with Chai : as a test framework
  • Helmet and CORS : to provide security and cross-origin resource sharing

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100