.. | ||
mixins | ||
models | ||
public | ||
services | ||
test | ||
types | ||
util | ||
.dockerignore | ||
.editorconfig | ||
.eslintrc.js | ||
.gitignore | ||
docker-compose.env | ||
docker-compose.yml | ||
Dockerfile | ||
k8s.yaml | ||
moleculer.config.ts | ||
package-lock.json | ||
package.json | ||
README.md | ||
tsconfig.json |
redplateaus
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.hello
- Call thegreeter.hello
action.call greeter.welcome --name John
- Call thegreeter.welcome
action with thename
parameter.call products.list
- List the products (call theproducts.list
action).
Services
- api: API Gateway services
- greeter: Sample service with
hello
andwelcome
actions. - products: Sample DB service. To use with MongoDB, set
MONGO_URI
environment variables and install MongoDB adapter withnpm i moleculer-db-adapter-mongo
.
Mixins
- db.mixin: Database access mixin for services. Based on moleculer-db
Useful links
- Moleculer website: https://moleculer.services/
- Moleculer Documentation: https://moleculer.services/docs/0.14/
NPM scripts
npm run dev
: Start development mode (load all services locally with hot-reload & REPL)npm run start
: Start production mode (setSERVICES
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 scriptnpm run lint
: Run ESLintnpm run ci
: Run continuous test mode with watchingnpm test
: Run tests & generate coverage reportnpm run dc:up
: Start the stack with Docker Composenpm run dc:down
: Stop the stack with Docker Compose