Welcome to moleculer-typescript-template 👋

My Moleculer-based microservices project

Prerequisites

• node >= 18.17.x

Init new project

npx degit jellydn/moleculer-typescript-template [PROJECT-NAME]

Features

• ⚡️ Progressive microservices framework for Node.js. Moleculer with Typescript template
• 📦 hygen - The scalable code generator that saves you time.
• 🦾 pino - super fast, all natural json logger
• 🔥 swagger-jsdoc - Generates swagger/openapi specification based on jsDoc comments and YAML files.
• ✨ moleculer-zod-validator - A validator for the Moleculer microservice framework to allow the use of Zod.
• 🔏 asteasolutions/zod-to-openapi - A library that generates OpenAPI (Swagger) docs from Zod schemas.
• 🪄 hey-api/openapi-ts - Turn your OpenAPI specification into a beautiful TypeScript client.

Install

pnpm install

Usage

# Copy env file
cp .env.example .env
pnpm dev

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.

pnpm cli --ns api

In the terminal, try the following commands:

• nodes - List all connected nodes.
• actions - List all registered service actions.
• call greeter.hello - Call the greeter.hello action.
• call greeter.welcome --username dunghd - Call the greeter.welcome action with the username parameter.

This project uses hygen to generate code templates, saving you time and ensuring consistency across your codebase.

Adding a New Service

To add a new service to your project, use the following command:

pnpm generate:service [service-name]

Adding a New Action to a Service

To add a new action to an existing service, use the following command:

pnpm generate:action [action-name] --service [service-name]

Generating CRUD Services

To generate a service with Create, Read, Update, and Delete (CRUD) operations, use the following command:

pnpm generate:crud [service-name]

API Documentation

This template also reads your JSDoc-annotated source code and generates an OpenAPI (Swagger) specification.

Run the following command to generate the Swagger documentation:

pnpm generate:swagger

Open the http://localhost:3000/docs URL in your browser, you will see the Swagger UI as

TypeScript SDK Generation

This template automatically generates a type-safe TypeScript SDK from your OpenAPI specification using @hey-api/openapi-ts.

Generating the SDK

To generate the TypeScript SDK from your OpenAPI specification:

pnpm generate:sdk

This command:

1. Reads the OpenAPI specification from public/docs/open-api.json
2. Generates TypeScript client code in generated/sdk/
3. Creates type-safe functions for all your API endpoints

Using the Generated SDK

The generated SDK provides a type-safe client for your API:

import {
    client,
    getApiGreeterHello,
    getApiGreeterWelcome,
    postApiProductCart,
} from "./generated/sdk";

// Configure the client
client.setConfig({
    baseUrl: "http://localhost:3000",
});

// Use type-safe API calls
const hello = await getApiGreeterHello();
const welcome = await getApiGreeterWelcome({
    query: { username: "John" },
});
const cartItem = await postApiProductCart({
    body: { name: "Product", qty: 1 },
});

SDK Regeneration Process

The SDK is automatically regenerated:

• During typecheck: pnpm typecheck runs generate:sdk first
• In CI/CD: The deploy workflow ensures SDK is current before type checking
• After API changes: Regenerate manually when you modify services or DTOs

Configuration

SDK generation is configured in openapi-ts.config.ts:

export default defineConfig({
    input: "public/docs/open-api.json", // OpenAPI spec source
    output: "generated/sdk", // Output directory
    plugins: ["@hey-api/client-fetch"], // HTTP client plugin
    exportCore: true, // Export client utilities
});

Note: The generated/ directory is in .gitignore and should not be committed. The SDK is generated fresh in CI/CD and during development.

Run tests

pnpm test

Deployment

This template comes with two GitHub Actions that handle automatically deploying your app to production and staging environments.

Prior to your first deployment, you'll need to do a few things:

• Install Fly

• Sign up and log in to Fly

  fly auth signup

• Create two apps on Fly, one for staging and one for production:

  fly create moleculer-typescript
  fly create moleculer-typescript-staging

• Create a new GitHub Repository

• Add a FLY_API_TOKEN to your GitHub repo. To do this, go to your user settings on Fly and create a new token, then add it to your repo secrets with the name FLY_API_TOKEN.

Now that every is set up you can commit and push your changes to your repo. Every commit to your main branch will trigger a deployment to your production environment, and every commit to your dev branch will trigger a deployment to your staging environment.

GitHub Actions

We use GitHub Actions for continuous integration and deployment. Anything that gets into the main branch will be deployed to production after running tests/build/etc. Anything in the dev branch will be deployed to staging.

Useful links

• Moleculer website: https://moleculer.services/
• Moleculer Documentation: https://moleculer.services/docs/0.14/

NPM scripts

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

Pre-commit hooks

This template uses Pre-commit to run checks before you commit your code. This ensures that your code is formatted correctly and passes all tests before you push it to your repository.

pre-commit install

To run the checks manually, use the following command:

pre-commit run --all-files

Author

👤 Dung Huynh

• Website: https://productsway.com/
• Twitter: @jellydn
• Github: @jellydn

Show your support

Give a ⭐️ if this project helped you!