1.0.0 ⢠Published 5 months ago
express-mysql-ts-starter v1.0.0
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
- Navigate to your project folder:
cd my-app
- Install dependencies (automatically done by CLI):
npm install
- Create a
.env
file based on.env.example
:cp .env.example .env
- 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