Please check ProblemStatement.md to check the tasks assigned for the project! or CLICK HERE
Please check Endpoints Folder to check all the endpoints for the project! or CLICK HERE
The TaskWise is a Django application designed to implement a team project planner tool. This tool provides APIs for managing users, teams, and tasks within a team board. The application follows a modular structure, with base abstract classes defining API methods. Concrete implementations of these base classes extend the base classes to create modules for the application. The inputs and outputs of the APIs are in JSON format, adhering to method-specific constraints and raising exceptions for invalid inputs. The application uses local file storage for persistence, with the db folder containing files for storing application data. Users interact with the application only through the APIs, without direct exposure to the internal file storage.
TaskWise is a Django REST framework (DRF) API project designed to facilitate team project planning. This application provides APIs for managing users, teams, and tasks with a team board. TaskWise aims to simplify the process of organizing and tracking project tasks within a team, ensuring efficient collaboration and task management.
TaskWise consists of the following components:
- Users Management: Create, list users, update, retrieve, and get a user's team.
- Teams Management: Create, List, update, retrieve, add user to team, remove user from team, and list team users .
- Team Board: Create, Close, List, and Export Board.
- Tasks Management: Add Task, update/close Task.
- Modular Structure: The application follows a modular structure with abstract base classes defining API methods, allowing for easy extension and customization.
To run TaskWise locally, follow these steps:
-
Clone Repositories:
- git clone https://github.com/mustafa854/TaskWise.git
- cd taskwise/
-
Create and activate a virtual environment:
python -m venv venv
source venv/bin/activate
- Install dependencies from requirements.txt:
pip install -r requirements.txt
-
Set up the local file storage:
- The application creates the necessary directory structure on startup.
-
Start the Django development server:
python manage.py runserver
- The API will be available at:
http://localhost:8000/api/
- Users
- GET /api/users/
- View all users.
- GET /api/users/teams/
- View teams associated with users.
- Teams
- GET /api/teams/
- View all teams.
- POST /api/teams/
- Create a new team.
- GET /api/teams/users/
- List users in a team.
- Boards
- GET /api/boards/
- List all boards.
- POST /api/boards/
- Create a new board.
- PATCH /api/boards/
- Update board status or close a board.
- 200 OK:
- Successful request.
- 201 Created:
- Successful creation of a resource.
- 400 Bad Request:
- Invalid request data.
- 404 Not Found:
- Resource not found.
- /api/users/: View and manage users.
- /api/users/teams: View user's teams.
- /api/teams/: View and manage teams.
- /api/teams/users: List users in a team.
- /api/boards/: View and manage boards
TaskWise is a comprehensive team project planner API with a range of features designed to facilitate efficient team collaboration and task management. Here are the key features provided by TaskWise:
-
User Management:
- Create User: API to create new users with unique names and display names.
- List Users: API to retrieve a list of all users with their details.
- Describe User: API to get detailed information about a specific user.
- Update User: API to update user details, including display names.
-
Team Management:
- Create Team: API to create new teams with unique names and descriptions.
- List Teams: API to retrieve a list of all teams with their details.
- Describe Team: API to get detailed information about a specific team.
- Update Team: API to update team details, such as names and descriptions.
- Add Users to Team: API to add users to a team, with a maximum limit of 50 users.
- Remove Users from Team: API to remove users from a team.
-
Project Board Management:
- Create Board: API to create new project boards with unique names and descriptions.
- Close Board: API to close a board, setting its status to CLOSED when all tasks are marked as COMPLETE.
- Add Task to Board: API to add tasks to a board, assigning them to a user with specific details.
- Update Task Status: API to update the status of a task to OPEN, IN_PROGRESS, or COMPLETE.
- List Boards: API to list all open boards for a specific team.
- Export Board: API to export a board in a presentable format to a text file in the "out" folder.
-
Persistence:
- TaskWise uses local file storage for persistence, ensuring data integrity and easy access.
- The db/ folder contains all files created to persist application data, maintaining separation from the user-facing APIs.
- Developers can choose the file format and data type for storage.
-
Input and Output:
- All APIs accept and return JSON strings as input and output, ensuring easy integration with various applications.
- The structure of JSON inputs and outputs is clearly defined in the method docstrings of each API.
- Constraints and Error Handling:
- Each API adheres to specific constraints, such as unique names, character limits, and maximum user additions.
- The APIs raise exceptions for invalid inputs, ensuring data integrity and error-free operation.
-
Scalability and Modularity:
- TaskWise follows a modular structure with base abstract classes defining API methods.
- Concrete implementation modules extend these base classes, allowing for easy scalability and customization.
-
Ease of Deployment:
- TaskWise can be easily deployed locally or on a server using Django's development server or production-grade deployment options.
-
Django:
- Web framework for building the API.
-
Django REST framework (DRF):
- Provides RESTful API development capabilities.