ts-microservice v1.0.3
TS Microservice Project Initializer
TS Microservice Project Initializer is a tool designed to help you quickly set up and initialize TypeScript-based microservices projects. It automates the process of creating project directories, installing dependencies, and configuring basic files, allowing you to jumpstart your microservices development with ease.
Features
- Initializes a TypeScript microservices project with a predefined directory structure.
- Sets up a basic
jest.config.jsfor testing using Jest. - Installs and configures Jest for unit and integration testing.
- Generates a
tsconfig.build.jsonfile for building the project. - Adds commonly used scripts to your
package.jsonfor testing, development, and building. - Integrates with
nodemonfor convenient development server auto-restart. - Initializes a Git repository for version control.
Getting Started
Prerequisites
Make sure you have Node.js and npm (Node Package Manager) installed on your system.
Installation
To create a new TypeScript microservices project using this initializer, open your terminal and run:
npx ts-microservices my-microservice-projectReplace my-microservice-project with your desired project name.
- Run tests:
npm test- Start development server (requires nodemon):
npm run dev- Build the project:
npm run buildFeel free to customize the project structure, files, and scripts to suit your specific requirements.
Contributing
Contributions are welcome! If you have suggestions, enhancements, or bug fixes, please open an issue or submit a pull request.
License
This project is licensed under the MIT License.