https://github.com/keneandita/task-manager-api
Task Manager API is a modular Flask REST API that allows you to manage tasks efficiently. It supports full CRUD operations with tasks having a title, description, and completion status. Built with SQLite, this project is easy to set up, extend, and use for learning or small projects.
https://github.com/keneandita/task-manager-api
api-management crud docker flask rest-api sql-alchemy
Last synced: 2 months ago
JSON representation
Task Manager API is a modular Flask REST API that allows you to manage tasks efficiently. It supports full CRUD operations with tasks having a title, description, and completion status. Built with SQLite, this project is easy to set up, extend, and use for learning or small projects.
- Host: GitHub
- URL: https://github.com/keneandita/task-manager-api
- Owner: KeneanDita
- Created: 2025-08-24T14:30:39.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-03-14T11:22:40.000Z (3 months ago)
- Last Synced: 2026-03-14T22:18:39.958Z (3 months ago)
- Topics: api-management, crud, docker, flask, rest-api, sql-alchemy
- Language: CSS
- Homepage:
- Size: 151 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Task Manager API
## Overview
**Task Manager API** is a modular RESTful API built with Flask that allows users to manage tasks in a simple and efficient way. It supports full **CRUD operations** (Create, Read, Update, Delete) with tasks having a **title, description, and completed status**.
This project demonstrates a clean, scalable Flask structure suitable for learning, testing, and small projects.
Checkout the docker built image : [Docker link](https://hub.docker.com/repository/docker/keneandita/taskmanagerapi/general)
### Author : [Kenean Dita](https://github.com/KeneanDita)
## Features
* Create, read, update, and delete tasks.
* Task fields: `title`, `description`, `completed`.
* JSON-based REST API responses.
* Modular Flask structure for scalability.
* Easy database population for demo/testing.
## Tech Stack
* **Backend:** Python, Flask, Flask-SQLAlchemy
* **Database:** SQLite
* **Testing:** Postman / cURL
* **Extras:** Flask Blueprints for modular structure
## Project Structure
```PS
task_manager_api/
│── app.py # Entry point of the app
│── requirements.txt # Python dependencies
│── populate.py # Script for demo population
│── Dockerfile # For Deployment Services
│── README.md
│
├── instance/
│ ├── tasks.db
│ └── config.py # Configuration settings (DB URI, debug)
│
└── app/
├── __init__.py # App factory & blueprint registration
├── models.py # Task model
├── routes.py # API endpoints (tasks + homepage)
└── utils.py # Optional helper functions
```
## Installation & Setup
### Clone the repository
```bash
git clone https://github.com/KeneanDita/Task-manager-API
cd Task-manager-API
```
### Create a virtual environment
```bash
python -m venv venv
source venv/bin/activate # Linux/macOS
venv\Scripts\activate # Windows
```
### Install dependencies
```bash
pip install -r requirements.txt
```
### Run the Application
```bash
python app.py
```
* Flask will run at: `http://127.0.0.1:5000/`
* Homepage: `http://127.0.0.1:5000/`
* Tasks API: `http://127.0.0.1:5000/tasks/`
## API Endpoints
| Method | Endpoint | Description |
| ------ | ------------- | ----------------------- |
| GET | `/` | Homepage info |
| GET | `/tasks/` | Get all tasks |
| GET | `/tasks/` | Get a task by ID |
| POST | `/tasks/` | Create a new task |
| PUT | `/tasks/` | Update an existing task |
| DELETE | `/tasks/` | Delete a task |
**Example POST body:**
```json
{
"title": "Buy groceries",
"description": "Get milk, eggs, bread, and vegetables",
"completed": false
}
```
**Example GET body:**
```json
{
"completed": false,
"description": "Read at least 50 pages of 'Clean Code'",
"id": 4,
"title": "Read a book"
}
```
### Populate Database (Demo) Using Python script
I have created `populate.py` with task data (10 tasks with title, description, completed). You can change it it's just better than manually entering tasks 1 by 1 just to check.
Run this command to populate the Database:
```bash
python populate.py
```
### Additional Notes
* **Database:** SQLite (`tasks.db`) is created automatically when the app runs.
* **Scalability:** Modular structure makes it easy to add users, authentication, or new resources.
* **Testing:** Recommended to use Postman or cURL to interact with the API.
* **Extensibility:** Easily extend endpoints for pagination, filtering, or search.
### License
This project is **free for everyone** yes, really!
Use it, learn from it, tweak it, or just stare at it in admiration.
No strings attached, no secret handshake required.
If you break it… hey, you only have yourself to blame.
Share it, fork it, remix it just have fun with it!