1.0.0 • Published 5 months ago

express-mysql-ts-starter v1.0.0

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

Express MySQL TypeScript Starter (EMTS)

EMTS is a CLI tool that helps you quickly set up an Express.js + MySQL + TypeScript project with best practices.

šŸš€ Installation

To install the CLI globally, run:

npm install -g express-mysql-ts-starter

šŸ“Œ Usage

To create a new project, run:

emts <project-name>

For example:

emts my-app

Options

  • --git : Initializes a Git repository.

Example:

emts my-app --git

šŸ“‚ Project Structure

After running the command, your project will have the following structure:

my-app/
│-- src/
│   │-- index.ts
│   │-- routes/
│   │-- controllers/
│   │-- models/
│   │-- middlewares/
│   │-- config/
│-- .gitignore
│-- package.json
│-- tsconfig.json
│-- README.md
│-- .env.example

šŸ”§ Next Steps

  1. Navigate to your project folder:
    cd my-app
  2. Install dependencies (automatically done by CLI):
    npm install
  3. Create a .env file based on .env.example:
    cp .env.example .env
  4. Run the project in development mode:
    npm run dev

✨ Features

  • Express.js with TypeScript
  • MySQL & Sequelize ORM
  • Environment variable support (dotenv)
  • Security middleware (helmet, cors)
  • Pre-configured folder structure

šŸ“œ License

This project is licensed under the MIT License.

1.0.0

5 months ago