Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 2.15 KB

README.md

File metadata and controls

45 lines (36 loc) · 2.15 KB
Raw

brokerplate

Moleculer-based microservices boilerplate

This is a Moleculer-based microservices project. Generated with the Moleculer CLI.

Usage

Start the project with npm run dev command. After starting, open the http://localhost:3000/ URL in your browser. On the welcome page you can test the generated services via API Gateway and check the nodes & services.

In the terminal, try the following commands:

  • nodes - List all connected nodes.
  • actions - List all registered service actions.
  • call greeter.health - Call the greeter.health action.
  • call greeter.hello - Call the greeter.hello action.
  • call greeter.welcome --name John - Call the greeter.welcome action with the name parameter.
  • call products.list - List the products (call the products.list action).

Services

  • api: API Gateway services.
  • greeter: Sample service with hello & welcome actions.
  • auth: Sample Auth service.
  • posts: Sample DB service.
  • products: Sample DB service.
  • lab: Moleculer's Laboratory service. Based on @moleculer/lab & article

Mixins

  • db.mixin: Database access mixin for services. Based on moleculer-db
  • redis.mixin: Redis access mixin for services.

Useful links

NPM scripts

  • npm run dev: Start development mode (load all services locally with hot-reload & REPL)
  • npm run start: Start production mode (set SERVICES env variable to load certain services)
  • npm run cli: Start a CLI and connect to production. Don't forget to set production namespace with --ns argument in script
  • npm run lint: Run ESLint
  • npm run ci: Run continuous test mode with watching
  • npm test: Run tests & generate coverage report
  • npm run dc:up: Start the stack with Docker Compose
  • npm run dc:down: Stop the stack with Docker Compose