generator-atomiq

generator-atomiq

Generate a Node microservice with Docker, Express, Babel, Node Inspector support, and optional directory-based routing conventions.

This is a generator for atomiq.

atomiq provides very lightweight structure and support useful for Express-based microservices. It is not a framework and doesn't get in the way of Express, but it does offer a nice convention for directory-based routing that you can use if you choose to.

This generator will scaffold an app that correctly handles signals for graceful server shutdown, including inside of a Docker container. It provides a useful set of docker-compose files for running containers for production and development (mounts the local dist directory during development).

It generates a few sample routes using ES6 classes and provides npm run script support for:

• npm run babel (includes support for ES6 and async/await)
• npm run watch
• npm run nodemon

Features:

• Docker support for production and development, including debugging support with Node Inspector
• Signal handling for graceful server shutdown (including inside of Docker containers)
• Babel support
• ESLint / esformatter support

Installation

First, install Yeoman and generator-atomiq using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-atomiq

Then generate your new microservice project:

yo atomiq [name]

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced. Feel free to learn more about him.

License

MIT © atomiq.io