pankod/moleculerjs-boilerplate

Moleculer JS Microservice Boilerplate with Typescript, TypeORM, CLI, Service Clients, Swagger, Jest, Docker, Eslint support and everything you will ever need to deploy rock solid projects.

Moleculer JS Microservice Boilerplate with Typescript, TypeORM, CLI, Service Helpers, Swagger, Jest, Docker, Eslint support and everything you will ever need to deploy rock solid projects..

_{Created by Pankod}

About

A microservice is a single self-contained unit which, together with many others, makes up a large application. By splitting your app into small units every part of it is independently deployable and scalable, can be written by different teams and in different programming languages and can be tested individually.

Moleculer is a fast, modern and powerful microservices framework for Node.js. It helps you to build efficient, reliable & scalable services.

This boilerplate make it easier to get started with a well-structured Node.js microservices with Typescript.

Features

This boilerplate includes the latest powerfull tools.

Moleculer - Moleculer is a fast, modern and powerful microservices framework for Node.js.
Typescript - Superset of JavaScript which primarily provides optional static typing, classes and interfaces. path support(allias)
Built-in Project CLI- Create services, entities, interfaces, and tests with one command by using built-in cli.
Docker - A tool designed to make it easier to create, deploy, and run applications by using containers.
Eslint - The pluggable linting utility.
Swagger - A framework backed by a large ecosystem of tools that helps developers design, build, document, and consume RESTful Web services.
Jest - Javascript testing framework , created by developers who created react
TypeORM - TypeORM is specifically an ORM that converts data between JavaScript / TypeScript to a variety of databases.
Service Helpers - Provides easy communication contract between services.

Setup & Documentation

Please refer to our setup guide to create a new app.

For more detailed documentation, check out https://pankod.github.io/moleculerjs-boilerplate/

Built-in CLI

moleculerjs-boilerplate is shipped with a CLI tool to streamline the creation of new microservices. By using the CLI tool, you may easily add entities, services to your project and have all the required interfaces and imports are automatically created for you.

To start the CLI, you may run the following npm command:

npm run cli

After answering questions it generates files in miliseconds.