📅 TaskFlow API

TaskFlow API is a REST API for collaborative task and board management.
It helps users manage boards, tasks, members, and permissions in a shared workflow environment.

📄 License

TaskFlow API is licensed under the terms described in the LICENSE file.
Please refer to the LICENSE file for complete license terms.

✨ Features

• JWT authentication
• Board management
• Task management
• Board members and roles
• Permission-based access control
• Swagger API documentation

🛠️ Tech stack

• NestJS
• TypeScript
• PostgreSQL
• TypeORM
• Docker / Docker Compose
• Makefile

🚀 Getting started

Build the project

Do not run development and production on the same PostgreSQL service.

make build PROFILE=<dev|prod>

Example:

make build PROFILE=dev

Start the project

make up PROFILE=<dev|prod>

Example:

make up PROFILE=dev

Stop the project

make down PROFILE=<dev|prod>

Example:

make down PROFILE=dev

⚙️ Environment

The project supports two profiles:

• dev for local development
• prod for production

Make sure each profile uses its own PostgreSQL service and environment configuration.

📘 API documentation

Swagger documentation is available when the application is running.

Typical local URL:

http://localhost:3000/docs

Adjust the port or route if your local configuration is different.

🎯 Project goal

TaskFlow API provides the backend for a collaborative task manager.
It is designed to support boards, task assignment, member roles, and permission-based actions in a clean REST architecture.

🔗 Repository

GitHub repository: TaskFlow API