Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tameronline/fastapi-todo
A professional Todo management system built with FastAPI and SQLAlchemy, designed for efficient task organization and enhanced with modern API and database practices.
https://github.com/tameronline/fastapi-todo
backend-development database fastapi project-structure python rest-api sqlalchemy task-management todo-app
Last synced: 14 days ago
JSON representation
A professional Todo management system built with FastAPI and SQLAlchemy, designed for efficient task organization and enhanced with modern API and database practices.
- Host: GitHub
- URL: https://github.com/tameronline/fastapi-todo
- Owner: TamerOnLine
- License: other
- Created: 2024-10-31T15:05:33.000Z (15 days ago)
- Default Branch: main
- Last Pushed: 2024-10-31T17:25:13.000Z (15 days ago)
- Last Synced: 2024-10-31T18:23:26.843Z (15 days ago)
- Topics: backend-development, database, fastapi, project-structure, python, rest-api, sqlalchemy, task-management, todo-app
- Language: Python
- Homepage: https://tameronline.github.io/FastAPI-Todo/
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/Code_of_Conduct.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# My FastAPI Todo Project
## Introduction
This project is a task management system developed using **FastAPI** as the API framework and **SQLAlchemy** for database management. It’s designed to be flexible and user-friendly, with a professional structure and modern technologies to ensure high performance and easy maintenance.
## Features
- **Add Tasks**: Add new tasks with multiple properties.
- **Update Tasks**: Support for updating task information through a dedicated API.
- **Delete Tasks**: Remove unwanted tasks from the database.
- **View Tasks**: Retrieve a list of available tasks with detailed information.
## Requirements
To run the project, the following requirements are needed:
- Python 3.7 or higher
- Python libraries:
- FastAPI
- SQLAlchemy
- Pydantic
Install the required packages using `requirements.txt` (if available):
```bash
pip install -r requirements.txt
```
## Usage
1. First, initialize the database by running the following command:
```bash
# Database initialization command
python init_db.py
```
2. Start the server with this command:
```bash
uvicorn main:app --reload
```
3. Access the interactive API documentation at:
```
http://127.0.0.1:8000/docs
```
## Project Structure
- `main.py`: The main application entry point.
- `db/database.py`: Database connection settings.
- `app/models/`: Contains database models.
- `app/schemas/`: Contains the schemas used in the API.
## Contribution
Contributions are welcome! Please open a pull request with your proposed changes. Ensure that all modifications adhere to the project's guidelines.
## License
This project is licensed under the MIT License.