isabella232 / generator-moleculer

Yeoman generator to generate a Moleculer project

Moleculer project generator

Create a new Moleculer microservices project

Installation

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

npm install -g yo
npm install -g generator-moleculer

Then generate your new Moleculer project (moleculer-demo):

yo moleculer moleculer-demo

Features

• Moleculer v0.12.x with moleculer.config.js
• Common project with a demo greeter service
• Optional API Gateway service
• Optional Transporter & Cacher
• Docker & Docker Compose files
• Unit tests with Jest
• Lint with ESLint
• Launch file for debugging in VSCode

NPM scripts

• npm run dev - Start service.js with hot-reload and start REPL
• npm run lint - Run ESLint
• npm run ci - Start testing in watch mode
• npm start - Start services in production mode
• npm test - Run tests & coverage

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

License

MIT © MoleculerJS