# ts-microservice

> A project initializer for TS microservices.

Latest version **1.0.3** (published 2023-08-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install ts-microservice
pnpm add ts-microservice
yarn add ts-microservice
bun add ts-microservice
```

Provides the command `ts-microservice`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2023-08-19 |
| First published | 2023-08-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | SebastianMB |
| Maintainers | sebastianmb-it |

## Links

- npm: https://www.npmjs.com/package/ts-microservice
- Repository: https://github.com/SebastianMB-IT/ts-microservice
- Issues: https://github.com/SebastianMB-IT/ts-microservice/issues
- npm.io page: https://npm.io/package/ts-microservice

## Dependencies (3)

- [fs](https://npm.io/package/fs.md) ^0.0.1-security
- [path](https://npm.io/package/path.md) ^0.12.7
- [child_process](https://npm.io/package/child_process.md) ^1.0.2

## Recent versions

- 1.0.3 (latest) — 2023-08-19
- 1.0.2 — 2023-08-18
- 1.0.1 — 2023-08-18
- 1.0.0 — 2023-08-17

## 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.

---
_Source: https://npm.io/package/ts-microservice · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._