- Introduction
- Features
- Prerequisites
- Installation
- Usage
- Folder Structure
- Environment Variables
- Running Tests
- Contributing
- License
This project is a Node.js application built with TypeScript, following the principles of Clean Architecture. It is designed to be modular, maintainable, and scalable.
- TypeScript support
- Clean Architecture
- Express.js for HTTP server
- Environment variable management with dotenv
- mySQL for database
- Middleware for request handling
- Example use cases and services
- Node.js (v16 or higher)
- npm (v8 or higher)
-
Clone the repository:
git clone https://github.com/yourusername/your-repo.git cd your-repo
-
Install dependencies:
npm install
-
Create a
.env
file in the root directory and add your environment variables. See Environment Variables for more details. -
Build the project:
npm run build
To start the server in development mode:
npm run dev