1.0.0 • Published 5 months ago

express-cli-creator v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
5 months ago

Express CLI

šŸš€ Express CLI is a simple command-line tool that allows you to quickly generate Express.js applications in either JavaScript or TypeScript.

šŸ“Œ Features

Choose between JavaScript or TypeScript projects

Automatically sets up project structure

Installs required dependencies

Supports EJS templating (optional)

šŸ“„ Installation

1ļøāƒ£ Install Globally

To use Express CLI globally, install it via npm:

npm install -g express-cli-generator

2ļøāƒ£ Usage

Create a new Express project by running:

express-cli create my-app

This will prompt you to choose between JavaScript and TypeScript.

3ļøāƒ£ Navigate & Install Dependencies

cd my-app npm install

4ļøāƒ£ Run the App

For JavaScript:

npm run dev

For TypeScript:

npm run dev # Runs with ts-node npm run build && npm start # Compiles and runs built JS files

⚔ Project Structure

my-app/
 ā”œā”€ā”€ src/
 │   ā”œā”€ā”€ controllers/
 │   ā”œā”€ā”€ middlewares/
 │   ā”œā”€ā”€ models/
 │   ā”œā”€ā”€ routes/
 │   ā”œā”€ā”€ index.js / index.ts
 ā”œā”€ā”€ config/
 ā”œā”€ā”€ public/
 ā”œā”€ā”€ views/ (if EJS is selected)
 ā”œā”€ā”€ package.json
 ā”œā”€ā”€ tsconfig.json (if TypeScript is selected)
 └── .gitignore

šŸ›  Contributing

Contributions are welcome! Follow these steps to contribute:

Fork the Repository

Clone your Fork

git clone https://github.com/your-username/express-cli.git

Install Dependencies

npm install

Make Your Changes

Test Your Changes

node index.js create test-app

Commit & Push

git add .

git commit -m "Your changes"

git push origin your-branch

Create a Pull Request

1.0.0

5 months ago