Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SebastianMB-IT/ts-microservice
TS Microservice Project Initializer a tool to create TypeScript projects for Node.
https://github.com/SebastianMB-IT/ts-microservice
microservices nodejs typescript
Last synced: about 1 month ago
JSON representation
TS Microservice Project Initializer a tool to create TypeScript projects for Node.
- Host: GitHub
- URL: https://github.com/SebastianMB-IT/ts-microservice
- Owner: SebastianMB-IT
- License: mit
- Created: 2023-08-17T17:12:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-19T15:28:26.000Z (over 1 year ago)
- Last Synced: 2024-10-29T22:00:46.458Z (about 2 months ago)
- Topics: microservices, nodejs, typescript
- Language: JavaScript
- Homepage:
- Size: 27.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - SebastianMB-IT/ts-microservice - TS Microservice Project Initializer a tool to create TypeScript projects for Node. (JavaScript)
README
# 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.js` for testing using Jest.
- Installs and configures Jest for unit and integration testing.
- Generates a `tsconfig.build.json` file for building the project.
- Adds commonly used scripts to your `package.json` for testing, development, and building.
- Integrates with `nodemon` for convenient development server auto-restart.
- Initializes a Git repository for version control.
## Getting Started
### Prerequisites
Make sure you have [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) (Node Package Manager) installed on your system.
### Installation
To create a new TypeScript microservices project using this initializer, open your terminal and run:
```sh
npx ts-microservices my-microservice-project
```
Replace my-microservice-project with your desired project name.
- Run tests:
```sh
npm test
```
- Start development server (requires nodemon):
```sh
npm run dev
```
- Build the project:
```sh
npm run build
```
Feel 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.