# qode-microservices

A CLI tool to scaffold Express.js + TypeScript microservice projects.  
Creates project folders, injects placeholders (project name, package name, port), initializes Git, and installs dependencies so you can start development quickly.

---

## Features

- Scaffold Express + TypeScript microservice boilerplate  
- Placeholder injection: `{{PACKAGE_NAME}}`, `{{PORT}}`  
- Git initialization (`git init`)  
- Automatic `npm install` after scaffold  
- Dev script ready (`npm run dev`)  

---

## Installation

```bash
npm install -g qode-microservices

Usage

Basic:

qode-microservices --package <npm-package-name> --port <port>

Short flags (example):

qode-microservices -p qode-rest-api --port 3001

What this does:

• Creates a folder named qode-rest-api
• Replaces {{PACKAGE_NAME}} in package.json with qode-rest-api
• Replaces {{PORT}} in server files with 3001
• Runs git init in the new folder
• Runs npm install in the new folder

Example CLI Output

hint: Using 'master' as the name for the initial branch. This default branch name
hint: is subject to change.
Initialized empty Git repository in /workspace/qode-rest-api/.git/
Installing dependencies...
added 297 packages, and audited 298 packages in 13s

48 packages are looking for funding
found 0 vulnerabilities

Project "qode-rest-api" created successfully!
Run 'cd qode-rest-api' and 'npm run dev' to start the server.

Git Default Branch Note

To set a different default branch globally:

git config --global init.defaultBranch main

Rename current branch:

git branch -m main

License

MIT © 2025