https://github.com/ujitkumar1/taskmaster
Task Management with Restful API Integration
https://github.com/ujitkumar1/taskmaster
flask-restful python restful-api task-manager
Last synced: 2 months ago
JSON representation
Task Management with Restful API Integration
- Host: GitHub
- URL: https://github.com/ujitkumar1/taskmaster
- Owner: ujitkumar1
- Created: 2023-02-13T13:31:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-15T13:29:33.000Z (over 3 years ago)
- Last Synced: 2026-01-03T20:44:25.684Z (5 months ago)
- Topics: flask-restful, python, restful-api, task-manager
- Language: Python
- Homepage: https://github.com/ujitkumar1/TaskMaster
- Size: 164 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## TaskMaster: Simple & Efficient Task Management with Restful API Integration
### Description:
TaskMaster is a task management application that aims to provide a simple and efficient way to organize and manage
tasks. It is designed to help individuals and teams to keep track of their daily tasks, prioritize their workload and
increase their productivity. TaskMaster is a streamlined task management solution that is exclusively focused on
delivering a restful API for managing tasks. It provides users with the ability to create, read, update, and delete
tasks, all through a flexible and easy-to-integrate API.
### Prerequisites:
1. Python Programming language
2. MySql
3. flask
4. flask_restful
5. json
6. Docker (Optional)
### Usage:
__Without Docker__
First change the directory to TaskMaster by executing the below command in the terminal
```
cd TaskMaster
```
To install the required packages and libraries, run the following command:
```
pip install -r requirements.txt
```
This command will install all the necessary dependencies listed in the requirements.txt file, allowing you to run the
project without any issues.
To run the application, execute the following command
```
python main.py
```
This will start the application, and you should be able to use it. (or) Directly run the main.py file
__With Docker__
run the below commands in the terminal to run the app using the docker
```
cd TaskMaster
docker build -t taskmaster -f Dockerfile/ .
docker run -p 5000:5000 taskmaster
```
### Endpoint Working:
CRUD Operations on TODO Items
1. To Create a todo item
url : http://127.0.0.1:5000/create (POST Request)
Input --> json_data = {"todo_item" : "Bring Vegetables from market"}
Output --> "TODO Item Saved:Bring Vegetables from market with todo_id: 1"
2. To View a todo item
url : http://127.0.0.1:5000/todo/1 (GET Request)
Here the url is in the format of "http://127.0.0.1:5000/todo/"
Output --> "The todo with id: 1, is 'Bring Vegetables from market' and it's incomplete"
3. To Delete a todo item
url : http://127.0.0.1:5000/todo/1 (DELETE Request)
Here the url is in the format of "http://127.0.0.1:5000/todo/"
Output --> "The todo with id: 2, is 'Bring Vegetables from market' is deleted successfully"
4. To Update a todo item
url : http://127.0.0.1:5000/todo/1 (PUT Request)
Here the url is in the format of "http://127.0.0.1:5000/todo/"
Input --> json_data = {"todo_item" : "Bring Potatoes from market"}
Output --> "The todo with id: 1, is updated to 'Bring Potatoes from market'"
5. To Update the Status of Todo Item:
url : http://127.0.0.1:5000/todo/status/1 (PUT Request)
Here the url is in the format of "http://127.0.0.1:5000/todo/status/"
Input --> json_data = {"todo_status":true }
Output --> "The todo with id: 1, status updated to'True'"
### Contact:
Name : Ujit Kumar
Email : ujitkumar1@gmail.com