https://github.com/ahmadhabibi14/task-management-api
Task Management API
https://github.com/ahmadhabibi14/task-management-api
docker express-validator expressjs mysql openapi swagger typescript
Last synced: about 1 year ago
JSON representation
Task Management API
- Host: GitHub
- URL: https://github.com/ahmadhabibi14/task-management-api
- Owner: ahmadhabibi14
- Created: 2024-11-07T09:09:54.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-08T08:48:05.000Z (over 1 year ago)
- Last Synced: 2025-01-06T03:41:33.284Z (about 1 year ago)
- Topics: docker, express-validator, expressjs, mysql, openapi, swagger, typescript
- Language: TypeScript
- Homepage:
- Size: 47.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Task Management REST API - Express.js, TypeScript, MySQL
## How to Setup and Run project ?
### 1. Pull docker-compose
```bash
docker-compose up -d
```
### 2. Make database migration
```bash
# Install DBmate
sudo curl -fsSL -o /usr/local/bin/dbmate https://github.com/amacneil/dbmate/releases/latest/download/dbmate-linux-amd64
sudo chmod +x /usr/local/bin/dbmate
# Start migration
dbmate new
dbmate up
dbmate down
# Dump schema
dbmate dump
# or
make db-dump
# Restore schema
dbmate load
```
### 3. Install Node.js Dependencies
```bash
npm install
# or
pnpm install
```
### 4. Run project (development)
```bash
pnpm dev
```
### 5. Build and run project (production)
```bash
# Build
pnpm build
# Start
pnpm start
```
The API Docs (Swagger) is available at path `/docs`, so I don't have to document it here