ExTurbo - Turbocharge Your Express App Development 🚀

ExTurbo is a blazing-fast, intuitive CLI tool designed to turbocharge your Express.js application development. Whether you're a beginner or a seasoned developer, ExTurbo enables you to set up fully-configured projects in seconds with simplicity and productivity in mind!

Table of Contents

• Features
• Installation
• Commands
• Create a New Project
• Example Workflow
• Project Structure
• Project Scripts
• What's Next?

Features

• Language Selection: Choose between JavaScript and TypeScript.
• Database Integration: Pre-configured setups for MongoDB or PostgreSQL.
• Live Reloading: Pre-installed and configured Nodemon for a smooth development experience.
• Customizable Templates: Get a project structure tailored to your needs.
• Environment Configuration: Automatically generated .env files for database credentials.

Installation

Install ExTurbo globally using npm:

npm install -g exturbo

Commands

Below are list of available commands.

• --create Create a new Express project
• --clean Cleanup your working directory
• --reset Reset project configuration
• --help Display this help menu

Create a New Project

To scaffold a new Express.js project, run the following command:

npx exturbo --create

You will be prompted to provide:

1. Project Name: Enter the name for your project.
2. Language: Choose between JavaScript or TypeScript.
3. Database: Select either MongoDB or PostgreSQL or Others.

Example Workflow

Running the CLI

npx exturbo --create

Prompts:

What is your project name?: express-app
Which language do you want to use? (JavaScript/TypeScript (Recommended)): TypeScript
Which database do you want to use? (MongoDB/PostgreSQL/Others): PostgreSQL

Result:

The following project structure is generated:

express-app/
│── controller/
│── middleware/
│── model/
│── routes/
│── utils/
|   └── pg.config.ts
├── .env
├── .gitignore
├── nodemon.json
├── package.json
│── server.ts
└── tsconfig.json

Project Scripts

Inside your project, the following scripts are pre-configured:

• Start the server

npm start

What's Next?

Now it's up to you to make your app awesome! Here are some suggestions:

1. Add your routes in the routes folder.
2. Configure your database models in the models folder.
3. Update the .env file with your own secrets and configurations.
4. Check the database configuration in the config folder
5. Customize your application logic in server.ts