create-mngts/README.md

Template for a Node.js project using TypeScript

create-mngts

Easily set up a new Node.js + TypeScript project in just a few seconds!
**create-mngts** is a tool designed to save you time by generating a ready-to-use project scaffold. It handles all the boring setup tasks so you can jump straight into coding. Plus, it adds a bit of fun with cheerful messages from a catgirl assistant!

## Why Use create-mngts?

Starting a new project can be tedious—setting up configuration files, installing dependencies, and initializing Git takes time. With **create-mngts**, you can skip all that and get started immediately with:

- A pre-configured Node.js + TypeScript setup
- Ready-to-use ESLint and Prettier configurations
- Automatic dependency installation
- Optional Git initialization (if Git is configured on your system)
- A touch of fun to brighten your day!

## How to Install

To use **create-mngts**, all you need is [Node.js](https://nodejs.org) installed on your machine. Then, run the following command:

```bash
npx create-mngts projectName
```

Replace `projectName` with the name of your new project. This will create a new directory with everything set up for you.

## Getting Started

Once the project is created, follow these steps to dive in:

1. Navigate to your new project directory:

```bash
cd projectName
```

2. Start the development server:

```bash
npm run dev
```

3. Open the `src/main.ts` file and start building your application!

## What’s Inside?

Here’s what your project structure will look like after it’s generated:

```
projectName/
├── package.json       # Project metadata and dependencies
├── tsconfig.json      # TypeScript configuration
├── .eslintrc.js       # ESLint rules for code quality
├── .prettierrc.js     # Prettier rules for consistent formatting
├── .gitignore         # Files and folders ignored by Git
└── src/
    └── main.ts        # Your project's entry point
```

Everything is set up for you, including TypeScript support and basic linting/formatting rules.

## Features

- **TypeScript Ready**: Start writing modern, type-safe JavaScript right away.
- **Linting \& Formatting**: ESLint and Prettier are pre-configured to keep your code clean and consistent.
- **Git Integration**: If Git is configured on your system, the tool will initialize a repository and make the first commit for you.
- **Dependencies Installed**: No need to manually run `npm install`—it’s all done for you.
- **Friendly Messages**: Enjoy fun and encouraging messages while the tool works its magic!

## License

This project is licensed under the [MIT License](LICENSE).

---

With **create-mngts**, starting a new Node.js + TypeScript project has never been easier—or more fun! Give it a try, and happy coding!