generator-service

Yeoman generator for REST services using express or koa

Usage no npm install needed!

<script type="module">
  import generatorService from 'https://cdn.skypack.dev/generator-service';
</script>

README

generator-service

Yeoman generator for REST services using express or koa

Features

  • Choose between express and koa as application frameworks
  • Choose between mocha and jasmine as test frameworks
  • When using mocha, choose between expect.js, should.js and chai as assertion libraries
  • Enables CORS
  • Enables graceful server shutdown
  • Creates a health check endpoint (e.g. for use with registrator and/or consul)
  • Creates a Dockerfile based on the alpine-node image
  • Creates npm scripts for running, testing, building and live-reloading/testing of the application

NOTE: This service template is by default optimized for use with node.js 4.x but can be easily adapted to earlier versions.

Getting Started

To install yeoman from npm, run:

npm install -g yo

To install generator-service from npm, run:

npm install -g generator-service

Finally, initiate the generator:

yo service

License

MIT