osisamkay/task_manager

Task Manager project

This is a FastAPI project for managing tasks, started with Docker.

Table of Contents

• Description
• Features
• Requirements
• Installation
• Usage
• Project Structure
• API Documentation
• Docker
• Contributing
• License

Description

This FastAPI project provides a RESTful API for managing tasks. It includes features such as task creation, retrieval, and more.

Features

• Task creation
• Task retrieval
• ...

Requirements

• Docker
• Docker Compose

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/my-fastapi-project.git

2. Navigate to the project directory:

   cd my-fastapi-project

3. Build the Docker image:

   docker-compose build

Usage

1. Start the Docker containers:

   docker-compose up

2. Open your browser and go to http://127.0.0.1:8000/docs for the Swagger documentation.

Project Structure

my_fastapi_project/
├── app/
│   ├── __init__.py
│   ├── main.py  # FastAPI application initialization
│   ├── routes/
│   │   ├── __init__.py
│   │   ├── task_routes.py
│   │   ├── user_routes.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── task.py
│   │   ├── user.py
│   ├── services/
│   │   ├── __init__.py
│   │   ├── user_service.py
│   │   ├── task_service.py
│   ├── utils/
│   │   ├── __init__.py
│   │   ├── auth.py
│   │   ├── nlp.py
│   │   ├── ai_prioritization.py
│
├── migrations/
│
├── tests/
│   ├── __init__.py
│   ├── test_task_routes.py
│   ├── test_user_routes.py
├── .env
├── requirements.txt
├── Dockerfile
├── docker-compose.yml

API Documentation

API documentation is available using Swagger UI. Open http://127.0.0.1:8000/docs in your browser to explore the API.

Docker

The project is Dockerized and can be run using Docker Compose. Ensure Docker and Docker Compose are installed on your machine.

Contributing

Feel free to contribute to this project by opening issues or submitting pull requests.

License

This project is licensed under the MIT License.

---