1.0.2 • Published 6 months ago
moleculer-fastify-devkit v1.0.2
moleculer-fastify-devkit
Description
moleculer-fastify-devkit
is a project starter package for building Moleculer-based microservices with Fastify. It helps you quickly set up a project structure, install necessary dependencies, and prepare all the layers required for building scalable services and applications using Moleculer and Fastify. This tool streamlines the setup of actions, controllers, routes, middlewares, services, error handling, validations, and localization.
Installation
To get started, you can create a new project using moleculer-fastify-devkit
with the following command:
npx create-project Your-Project-Name
This will automatically install the required dependencies and set up the necessary project structure.
Alternatively, you can install the package globally to make it available from anywhere:
npm install -g moleculer-fastify-devkit
Then you can create a new project by running:
create-project Your-Project-Name
Usage
Once you've installed the package, you can create a new project by running:
npx create-project Your-Project-Name
This command will create a new project with the following folder structure:
/project-root
/src
/actions
/controllers
/models
/middlewares
/services
/utils
/config
/routes
.env
package.json
index.js
What You Get
actions/: Place your Moleculer actions here.
controllers/: Controllers to handle the logic of each route.
models/: Models for your data layer.
middlewares/: Middlewares to manage logic before or after routes and actions.
services/: Moleculer services that define your application’s logic.
utils/: Utility functions to be used across your application.
config/: Configuration files (e.g., Fastify settings, Moleculer configuration).
routes/: API routes that are handled by Fastify.
Key Features
Quick setup: Instantly set up a Moleculer-Fastify project with just a command.
Pre-configured structure: Get a well-organized folder structure for your services, actions, routes, and more.
Customizable: Easily modify the generated structure to fit your project needs.
Fastify + Moleculer: Combines the power of Fastify for API management and Moleculer for microservices architecture.
Pre-installed dependencies: Includes necessary libraries for Fastify, Moleculer, CORS, form bodies, JWT, database integration, and more.
Example
After running npx create-project Your-Project-Name, your project will be organized like this:
/project-root
/src
/actions
userActions.js # Example action
/controllers
userController.js # Example controller
/models
userModel.js # Example model
/middlewares
authMiddleware.js # Example middleware
/services
userService.js # Example service
/utils
helpers.js # Example utility function
/config
fastify.js # Fastify configuration
/routes
userRoutes.js # Example routes for users
.env
package.json
index.js
License
This project is licensed under the ISC License. See the LICENSE file for more details.