typescript-express-starter 10.2.1 → 11.0.0

package/README.md

@@ -1,6 +1,6 @@
 <h1 align="center">
 <br>
-  <img src="https://github.com/ljlm0402/typescript-express-starter/raw/images/logo.jpg" alt="Project Logo" />
+  <img src="https://github.com/ljlm0402/typescript-express-starter/raw/images/newLogo.png" alt="Project Logo" />
   <br>
     <br>
   TypeScript Express Starter
@@ -52,279 +52,165 @@
 
 <br />
 
-## 😎 Introducing The Project
+---
 
-Express consists of JavaScript, which makes it vulnerable to type definitions.
+## 📝 Introduction
 
-That's why we avoid supersets with starter packages that introduce TypeScript.
+**TypeScript Express Starter** is an interactive CLI tool that generates production-ready TypeScript Express projects with your preferred stack configuration.
 
-The package is configured to use TypeScript instead of JavaScript.
+Instead of starting from scratch, this CLI provides a comprehensive project generator with multiple database integrations, development tools, and deployment configurations. Choose from 10+ templates and customize your development workflow in minutes.
 
-> The project referred to [express-generator-typescript](https://github.com/seanpmaxwell/express-generator-typescript)
+- **Interactive Setup**: Choose database, ORM, linter, testing framework, and more
+- **Production Ready**: Docker, PM2, NGINX configurations included
+- **Developer Experience**: Hot reload, testing, linting, and formatting pre-configured
+- **Multiple Stacks**: Support for 10+ database/ORM combinations
 
-### 🤔 What is Express ?
+## 💎 CLI Features
 
-Express is a fast, open and concise web framework and is a Node.js based project.
+- 🎯 **Interactive Setup** — Smart CLI with guided project configuration
 
-## 🚀 Quick Start
+- 🗄️ **Multiple Database Options** — Prisma, Sequelize, TypeORM, Mongoose, Knex, and more
 
-### Install with the npm Global Package
+- 🛠️ **Development Tools** — Choose from ESLint, Biome, Jest, Vitest, Docker, PM2
 
-```bash
-$ npm install -g typescript-express-starter
-```
-
-### Run npx to Install The Package
-
-npx is a tool in the JavaScript package management module, npm.
-
-This is a tool that allows you to run the npm package on a single run without installing the package.
-
-If you do not enter a project name, it defaults to _typescript-express-starter_.
-
-```bash
-$ npx typescript-express-starter "project name"
-```
-
-### Select a Templates
-
-<img src="https://github.com/ljlm0402/typescript-express-starter/raw/images/cli.gif" alt="Example Cli" />
-
-Start your typescript-express-starter app in development mode at `http://localhost:3000/`
-
-#### Template Type
-
-| Name                                                                    | Description                                                                                                                                                |
-| :---------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Default                                                                 | Express Default                                                                                                                                            |
-| [Routing Controllers](https://github.com/typestack/routing-controllers) | Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage                                               |
-| [Sequelize](https://github.com/sequelize/sequelize)                     | Easy to use multi SQL dialect ORM for Node.js                                                                                                              |
-| [Mongoose](https://github.com/Automattic/mongoose)                      | MongoDB Object Modeling(ODM) designed to work in an asynchronous environment                                                                               |
-| [TypeORM](https://github.com/typeorm/typeorm)                           | An ORM that can run in Node.js and Others                                                                                                                  |
-| [Prisma](https://github.com/prisma/prisma)                              | Modern Database Access for TypeScript & Node.js                                                                                                            |
-| [Knex](https://github.com/knex/knex)                                    | SQL query builder for Postgres, MySQL, MariaDB, SQLite3 and Oracle                                                                                         |
-| [GraphQL](https://github.com/graphql/graphql-js)                        | query language for APIs and a runtime for fulfilling those queries with your existing data                                                                 |
-| [Typegoose](https://github.com/typegoose/typegoose)                     | Define Mongoose models using TypeScript classes                                                                                                            |
-| [Mikro ORM](https://github.com/mikro-orm/mikro-orm)                     | TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL and SQLite databases |
-| [Node Postgres](https://node-postgres.com/)                             | node-postgres is a collection of node.js modules for interfacing with your PostgreSQL database                                                             |
-
-#### Template to be developed
-
-| Name                                                                            | Description                                                                |
-| :------------------------------------------------------------------------------ | :------------------------------------------------------------------------- |
-| [Sequelize Typescript](https://github.com/RobinBuschmann/sequelize-typescript)  | Decorators and some other features for sequelize                           |
-| [TS SQL](https://github.com/codemix/ts-sql)                                     | A SQL database implemented purely in TypeScript type annotations           |
-| [inversify-express-utils](https://github.com/inversify/inversify-express-utils) | Some utilities for the development of Express application with InversifyJS |
-| [postgress typescript]()                                                        |                                                                            |
-| [graphql prisma]()                                                              |                                                                            |
-
-## 🛎 Available Commands for the Server
-
-- Run the Server in production mode : `npm run start` or `Start typescript-express-starter` in VS Code
-- Run the Server in development mode : `npm run dev` or `Dev typescript-express-starter` in VS Code
-- Run all unit-tests : `npm test` or `Test typescript-express-starter` in VS Code
-- Check for linting errors : `npm run lint` or `Lint typescript-express-starter` in VS Code
-- Fix for linting : `npm run lint:fix` or `Lint:Fix typescript-express-starter` in VS Code
-
-## 💎 The Package Features
-
-<p>
-  <img src="https://img.shields.io/badge/-TypeScript-007ACC?style=for-the-badge&logo=TypeScript&logoColor=fff" />&nbsp;&nbsp;
-  <img src="https://img.shields.io/badge/-Node.js-339933?style=for-the-badge&logo=Node.js&logoColor=fff" />&nbsp;&nbsp;
-  <img src="https://img.shields.io/badge/-NPM-CB3837?style=for-the-badge&logo=NPM&logoColor=fff" />&nbsp;&nbsp;
-</p>
-<p>
-  <img src="https://img.shields.io/badge/-Docker-2496ED?style=for-the-badge&logo=Docker&logoColor=fff" />&nbsp;&nbsp;
-  <img src="https://img.shields.io/badge/-NGINX-269539?style=for-the-badge&logo=NGINX&logoColor=fff" />
-  <img src="https://img.shields.io/badge/-PM2-2B037A?style=for-the-badge&logo=PM2&logoColor=fff" />&nbsp;&nbsp;
-  <img src="https://img.shields.io/badge/-Nodemon-76D04B?style=for-the-badge&logo=Nodemon&logoColor=fff" />&nbsp;&nbsp;
-  <img src="https://img.shields.io/badge/-ESLint-4B32C3?style=for-the-badge&logo=ESLint&logoColor=fff" />&nbsp;&nbsp;
-  <img src="https://img.shields.io/badge/-Prettier-F7B93E?style=for-the-badge&logo=Prettier&logoColor=000" />&nbsp;&nbsp;
-  <img src="https://img.shields.io/badge/-Jest-C21325?style=for-the-badge&logo=Jest&logoColor=fff" />&nbsp;&nbsp;
-  <img src="https://img.shields.io/badge/-Swagger-85EA2D?style=for-the-badge&logo=Swagger&logoColor=000" />
-  <img src="https://img.shields.io/badge/-SWC-FFFFFF?style=for-the-badge&logo=swc&logoColor=FBE1A6" />
-</p>
-<p>
-  <img src="https://img.shields.io/badge/-MySQL-4479A1?style=for-the-badge&logo=MySQL&logoColor=fff" />&nbsp;&nbsp;
-  <img src="https://img.shields.io/badge/-MariaDB-003545?style=for-the-badge&logo=MariaDB&logoColor=fff" />&nbsp;&nbsp;
-  <img src="https://img.shields.io/badge/-PostgreSQL-336791?style=for-the-badge&logo=PostgreSQL&logoColor=fff" />&nbsp;&nbsp;
-  <img src="https://img.shields.io/badge/-MongoDB-47A248?style=for-the-badge&logo=MongoDB&logoColor=fff" />
-</p>
-
-### 🐳 Docker :: Container Platform
-
-[Docker](https://docs.docker.com/) is a platform for developers and sysadmins to build, run, and share applications with containers.
-
-[Docker](https://docs.docker.com/get-docker/) Install.
-
-- starts the containers in the background and leaves them running : `docker-compose up -d`
-- Stops containers and removes containers, networks, volumes, and images : `docker-compose down`
-
-Modify `docker-compose.yml` and `Dockerfile` file to your source code.
-
-### ♻️ NGINX :: Web Server
-
-[NGINX](https://www.nginx.com/) is a web server that can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache.
-
-Proxying is typically used to distribute the load among several servers, seamlessly show content from different websites, or pass requests for processing to application servers over protocols other than HTTP.
-
-When NGINX proxies a request, it sends the request to a specified proxied server, fetches the response, and sends it back to the client.
-
-Modify `nginx.conf` file to your source code.
+- 📱 **Template Selection** — 10+ pre-configured project templates
 
-### ✨ ESLint, Prettier :: Code Formatter
+- ⚡ **Auto Configuration** — Dependencies, scripts, and configs automatically setup
 
-[Prettier](https://prettier.io/) is an opinionated code formatter.
+- 🔧 **Smart Dependencies** — Tool compatibility and requirement resolution
 
-[ESLint](https://eslint.org/), Find and fix problems in your JavaScript code
+- 📦 **Package Manager Agnostic** — Works with npm, pnpm, or yarn
 
-It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary.
+- 🚀 **Zero Config Start** — Generated projects work immediately
 
-1. Install [VSCode](https://code.visualstudio.com/) Extension [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode), [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+- 🎨 **Customizable** — Add your own templates and development tools
 
-2. `CMD` + `Shift` + `P` (Mac Os) or `Ctrl` + `Shift` + `P` (Windows)
+## ⚡️ Quick Start
 
-3. Format Selection With
-
-4. Configure Default Formatter...
-
-5. Prettier - Code formatter
-
-<img src="https://user-images.githubusercontent.com/42952358/126604937-4ef50b61-b7e4-4635-b3c9-3c94dd6b06fa.png" alt="Formatter Setting" />
-
-> Palantir, the backers behind TSLint announced in 2019 that they would be deprecating TSLint in favor of supporting typescript-eslint in order to benefit the community.
-> So, migration from TSLint to ESLint.
-
-### 📗 Swagger :: API Document
-
-[Swagger](https://swagger.io/) is Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset.
-
-Easily used by Swagger to design and document APIs at scale.
-
-Start your app in development mode at `http://localhost:3000/api-docs`
-
-Modify `swagger.yaml` file to your source code.
-
-### 🌐 REST Client :: HTTP Client Tools
-
-REST Client allows you to send HTTP request and view the response in Visual Studio Code directly.
-
-VSCode Extension [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) Install.
-
-Modify `*.http` file in src/http folder to your source code.
-
-### 🔮 PM2 :: Advanced, Production process manager for Node.js
-
-[PM2](https://pm2.keymetrics.io/) is a daemon process manager that will help you manage and keep your application online 24/7.
-
-- production mode :: `npm run deploy:prod` or `pm2 start ecosystem.config.js --only prod`
-- development mode :: `npm run deploy:dev` or `pm2 start ecosystem.config.js --only dev`
-
-Modify `ecosystem.config.js` file to your source code.
-
-### 🏎 SWC :: a super-fast JavaScript / TypeScript compiler
-
-[SWC](https://swc.rs/) is an extensible Rust-based platform for the next generation of fast developer tools.
-
-`SWC is 20x faster than Babel on a single thread and 70x faster on four cores.`
+```bash
+# Install globally
+npm install -g typescript-express-starter
 
-- tsc build :: `npm run build`
-- swc build :: `npm run build:swc`
+# Run the interactive CLI
+typescript-express-starter
 
-Modify `.swcrc` file to your source code.
+# Follow the prompts to:
+# 1. Choose package manager (npm/pnpm/yarn)
+# 2. Select project template (default/prisma/sequelize/etc.)
+# 3. Enter project name
+# 4. Pick development tools (linting/testing/docker/etc.)
 
-### 💄 Makefile :: This is a setting file of the make program used to make the compilation that occurs repeatedly on Linux
+# Navigate to your project
+cd your-project-name
 
-[Makefile](https://makefiletutorial.com/)s are used to help decide which parts of a large program need to be recompiled.
+# Start development server
+npm run dev
+```
 
-- help :: `make help`
+**Generated Project Features:**
+- 🌐 Express server: `http://localhost:3000/`
+- 📚 Auto-generated API docs: `http://localhost:3000/api-docs`
+- 🔄 Hot reload with nodemon
+- 🧪 Testing setup included
 
-Modify `Makefile` file to your source code.
+## 📂 Generated Project Structure
 
-## 🗂 Code Structure (default)
+When you create a new project, the CLI generates this structure:
 
-```sh
-│
-├──📂 .vscode
-│  ├── launch.json
-│  └── settings.json
-│
-├──📂 src
-│  ├──📂 config
-│  │  └── index.ts
-│  │
-│  ├──📂 controllers
-│  │  ├── auth.controller.ts
-│  │  └── users.controller.ts
-│  │
-│  ├──📂 dtos
-│  │  └── users.dto.ts
-│  │
-│  ├──📂 exceptions
-│  │  └── httpException.ts
-│  │
-│  ├──📂 http
-│  │  ├── auth.http
-│  │  └── users.http
-│  │
-│  ├──📂 interfaces
-│  │  ├── auth.interface.ts
-│  │  ├── routes.interface.ts
-│  │  └── users.interface.ts
-│  │
-│  ├──📂 middlewares
-│  │  ├── auth.middleware.ts
-│  │  ├── error.middleware.ts
-│  │  └── validation.middleware.ts
-│  │
-│  ├──📂 models
-│  │  └── users.model.ts
-│  │
-│  ├──📂 routes
-│  │  ├── auth.route.ts
-│  │  └── users.route.ts
-│  │
-│  ├──📂 services
-│  │  ├── auth.service.ts
-│  │  └── users.service.ts
-│  │
-│  ├──📂 test
-│  │  ├── auth.test.ts
-│  │  └── users.test.ts
-│  │
-│  ├──📂 utils
-│  │  ├── logger.ts
-│  │  └── vaildateEnv.ts
-│  │
-│  ├── app.ts
-│  └── server.ts
-│
-├── .dockerignore
-├── .editorconfig
-├── .env.development.local
-├── .env.production.local
-├── .env.test.local
-├── .eslintignore
-├── .eslintrc
-├── .gitignore
-├── .huskyrc
-├── .lintstagedrc.json
-├── .prettierrc
-├── .swcrc
-├── docker-compose.yml
-├── Dockerfile.dev
-├── Dockerfile.prod
-├── ecosystem.config.js
-├── jest.config.js
-├── Makefile
-├── nginx.conf
-├── nodemon.json
-├── package-lock.json
-├── package.json
-├── swagger.yaml
-└── tsconfig.json
+```bash
+your-project/
+├── src/
+│   ├── config/           # Configuration files, environment settings
+│   ├── controllers/      # Request handling & response logic
+│   ├── dtos/             # Data Transfer Objects for request/response
+│   ├── entities/         # Database entities/models (if ORM selected)
+│   ├── exceptions/       # Custom exception classes
+│   ├── interfaces/       # TypeScript interfaces and type definitions
+│   ├── middlewares/      # Middlewares (logging, auth, error handling)
+│   ├── repositories/     # Database access logic
+│   ├── routes/           # API route definitions
+│   ├── services/         # Business logic
+│   ├── utils/            # Utility/helper functions
+│   ├── app.ts            # Express app initialization
+│   └── server.ts         # Server entry point
+├── .env*                 # Environment variables (multiple stages)
+├── nodemon.json          # Development server configuration
+├── package.json          # Dependencies and scripts
+├── tsconfig.json         # TypeScript configuration
+└── docker-compose.yml    # Docker setup (if selected)
 ```
 
+## 🛠 Development Tools Available
+
+Choose from these categories during project setup:
+
+| Category      | Available Tools          | Description                                     |
+| ------------- | ------------------------ | ----------------------------------------------- |
+| **Linter**    | `biome`, `eslint`        | Code formatting & linting (Biome is all-in-one) |
+| **Bundler**   | `swc`, `tsup`           | Fast TypeScript compilation and bundling       |
+| **Testing**   | `jest`, `vitest`        | Unit & integration testing frameworks          |
+| **Process**   | `pm2`                   | Production process management                   |
+| **CI/CD**     | `github`                | GitHub Actions workflows                        |
+| **Git Hooks** | `husky`                 | Pre-commit hooks for quality control           |
+| **Container** | `docker`                | Docker & docker-compose configuration          |
+| **API Docs**  | `swagger`               | OpenAPI/Swagger documentation                  |
+
+**Smart Selection**: The CLI automatically resolves tool dependencies and compatibility.
+
+## 🧩 Available Templates
+
+Current template status (more coming soon!):
+
+### ✅ **Currently Available**
+| Template   | Description                    | Status |
+| ---------- | ------------------------------ | ------ |
+| `default`  | Express + TypeScript starter   | ✅ Active |
+
+### 🚧 **Coming Soon**
+
+#### **ORM/Database Integration**
+| Template           | Description                    | Priority |
+| ------------------ | ------------------------------ | -------- |
+| `prisma`           | Type-safe database client with auto-generated types         | 🔥 High  |
+| `drizzle`          | TypeScript-first ORM with zero runtime overhead              | 🔥 High  |
+| `mikro-orm`        | Data Mapper ORM pattern for TypeScript           | 🔥 High  |
+| `mongoose`         | Elegant MongoDB ODM for Node.js         | 🔥 High  |
+| `node-postgres`    | High-performance PostgreSQL native driver      | 🚧 In Dev |
+| `knex`             | Flexible SQL query builder & migrations      | 🚧 In Dev |
+| `typeorm`          | Decorator-based Active Record ORM            | 🚧 In Dev |
+| `sequelize`        | Mature Promise-based SQL ORM                  | 🚧 In Dev |
+| `typegoose`        | TypeScript-friendly Mongoose alternative            | 🚧 In Dev |
+
+#### **Architecture/Controller Style**
+| Template           | Description                    | Priority |
+| ------------------ | ------------------------------ | -------- |
+| `graphql`          | GraphQL API schema with Apollo Server        | 🚧 In Dev |
+
+> **Note**: Currently focusing on the `default` template. Additional templates will be activated as they're completed and tested.
+
+## 🤔 Why Use This CLI?
+
+### vs. Manual Setup
+| Aspect           | Manual Setup                      | TypeScript Express Starter CLI        |
+| ---------------- | --------------------------------- | ------------------------------------- |
+| **Time**         | 🔴 Hours of configuration          | ✅ 2-3 minutes interactive setup      |
+| **Configuration** | 🔴 Manual dependency management    | ✅ Auto-resolved, compatible versions  |
+| **Best Practices** | 🔴 Research required            | ✅ Pre-configured industry standards  |
+| **Consistency**  | 🔴 Varies by developer           | ✅ Standardized project structure     |
+| **Updates**      | 🔴 Manual maintenance             | ✅ CLI updates bring new features     |
+
+### vs. Other Generators
+| Feature          | TypeScript Express Starter | Other Generators |
+| ---------------- | -------------------------- | ---------------- |
+| **Database Choice** | ✅ 10+ options planned       | Limited options  |
+| **Tool Selection**  | ✅ Mix & match dev tools    | Fixed stack      |
+| **TypeScript First** | ✅ Built for TypeScript    | Often JS-first   |
+| **Production Ready** | ✅ Docker, PM2 included    | Basic setup      |
+
+## 📄 License
+
+MIT(LICENSE) © AGUMON (ljlm0402)
+
 ## ⭐️ Stargazers
 
 [![Stargazers repo roster for @ljlm0402/typescript-express-starter](https://reporoster.com/stars/ljlm0402/typescript-express-starter)](https://github.com/ljlm0402/typescript-express-starter/stargazers)
@@ -336,29 +222,3 @@ Modify `Makefile` file to your source code.
 ## 🤝 Contributors
 
 [![Contributors repo roster for @ljlm0402/typescript-express-starter](https://contributors-img.web.app/image?repo=ljlm0402/typescript-express-starter)](https://github.com/ljlm0402/typescript-express-starter/graphs/contributors)
-
-## 💳 License
-
-[MIT](LICENSE)
-
-## 📑 Recommended Commit Message
-
-| When             | Commit Message     |
-| :--------------- | :----------------- |
-| Add Feature      | ✨ Add Feature     |
-| Fix Bug          | 🐞 Fix Bug         |
-| Refactoring Code | 🛠 Refactoring Code |
-| Install Package  | 📦 Install Package |
-| Fix Readme       | 📚 Fix Readme      |
-| Update Version   | 🌼 Update Version  |
-| New Template     | 🎉 New Template    |
-
-## 📬 Please request an issue
-
-Please leave a question or question as an issue.
-
-I will do my best to answer and reflect.
-
-Thank you for your interest.
-
-# ദ്ദി*ˊᗜˋ*)