🚀 TypeScript-Express Backend Setup CLI

A CLI tool to quickly setup an Express.js backend in TypeScript, using essential configurations and user's preferences.

⚡ Installation

You can directly run the CLI (using npx) or install globally (using npm install -g) :

1# Run directly using npx
2npx create-types-backend
3
4# OR Install globally (optional)
5npm install -g create-types-backend

📦 Features

✅ Generates a well-structured Express-TypeScript backend
✅ Supports automatic setup using -y flag
✅ Includes Express.js, Typescript, DotEnv and essential configurations
✅ Sets up tsx for hot-reloading while development
✅ Resolves default import alias by mapping src -> @

⚙️ Optional support for:

- Custom Error Handlers
- CORS
- MongoDB
- JWT, bcrypt, cookie-parser
- Multer
- Cloudinary
- ES-Lint
- Docker

🚀 Usage

➡️ Creating a new project

1npx create-types-backend  : Manual setup with flexibility to choose required configurations.
2
3OR
4
5npx create-types-backend  -y : Run in default mode with all preferences set to 'YES'
6
7OR
8
9npx create-types-backend  myapp : Enter project name through CLI argument

➡️ Starting the Development Server

1Just follow these 3 steps:
2
3-   cd into the newly created backend directory
4-   add your MONGODB_URI in .env file (if using MongoDB)
5-   npm run dev OR npm run docker:dev (if using docker)

🛠️ Project Structure

1myapp/
2│── src/
3    ├── config/                     # Configuration files (e.g., database)
4       	├──db.ts		            # MongoDB connection setup
5       	├──multer.ts	            # Multer setup
6    ├── constants/                  # Constant values
7        ├──cookie-options.ts	    # Cookie options for JWT
8    ├── controllers/                # Route handlers
9       	├──user.ts	                # Example controller
10    ├── helpers/                    # Helper functions
11    ├── middlewares/                # Express middlewares
12       	├──errorHandler.ts	        # Custom error handler
13    ├── models/                     # Mongoose models
14       	├──user.ts	                # Example mongoose model
15    ├── routes/                     # API routes
16       	├──user.ts	                # Example route
17    ├── types/                      # TypeScript types
18       	├──file.d.ts	            # FileTypes definition (reqd for cloudinary)
19       	├──user.d.ts	            # UserTypes definition (acc to example mongoose schema)
20    ├── utils/                      # Reusable utilities
21       	├──cloudinary.ts	        # Cloudinary upload and delete controllers
22        ├──generate-token.ts	    # Generate JWT token and set cookie
23       	├──try-catch.ts	            # Try-Catch wrapper for async functions
24    ├── app.ts                      # Main entry point of express app
25│── .dockerignore                   # Docker ignore file
26│── .env                            # Environment variables
27│── .env.example                    # Example environment variables
28│── .gitignore                      # Git ignore file
29│── .prettierrc                     # Prettier configuration
30│── docker-compose.yaml             # Docker-Compose file configured for development
31│── Dockerfile                      # Dockerfile for production
32│── Dockerfile.dev                  # Dockerfile for development
33│── eslint.config.js                # ESLint configuration for code linting
34│── package.json                    # Project metadata & dependencies
35│── tsconfig.json                   # TypeScript configuration
36

🤝 Contributing

Want to improve this CLI? Feel free to fork the project, make changes, and submit a pull request (PR).

Steps to Contribute:

1. Fork this repository.
2. Clone your fork locally.
3. Create a new branch for your feature/fix.
4. Commit your changes and push them.
5. Submit a pull request for review.

📜 License

This project is open-source and available under the ISC License.

👨‍💻 Author

Raghav Bhagat
🔗 GitHub: [https://github.com/rbhagat32]
🔗 NPM: [https://www.npmjs.com/~raghavbhagat32]
🔗 LinkedIn: [https://www.linkedin.com/in/rbhagat32]