https://github.com/vbdv2000/mynotes

Project and Tasks Management with Python
https://github.com/vbdv2000/mynotes

docker docker-compose fastapi python

Last synced: 2 months ago
JSON representation

Project and Tasks Management with Python

• Host: GitHub
• URL: https://github.com/vbdv2000/mynotes
• Owner: vbdv2000
• License: mit
• Created: 2025-09-25T20:23:52.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-10-05T23:30:59.000Z (9 months ago)
• Last Synced: 2025-10-06T01:16:23.374Z (9 months ago)
• Topics: docker, docker-compose, fastapi, python
• Homepage:
• Size: 120 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Task Manager

A simple and intuitive task manager built with Python (FastAPI), Vue.js, and PostgreSQL.

## 🚀 Features

- **User Authentication:** Secure and modern user management with JWT.

- **Project Management:** Create and manage projects.

- **Task Board:** A visual task board (Kanban style) with drag-and-drop functionality to change task status.

- **Role-Based Access:** Assign users to projects and control permissions.

## 🛠️ Tech Stack

- **Backend:**

    - **FastAPI:** High-performance Python API framework.

    - **SQLAlchemy:** SQL Toolkit and Object-Relational Mapper (ORM).

    - **PostgreSQL:** Robust relational database.

- **Frontend:**

    - **Vue.js:** Progressive JavaScript framework for building user interfaces.

    - **Vite:** Next-generation frontend tooling.

- **Tooling:**

    - **Docker & Docker Compose:** Containerization for easy setup and deployment.

    - **uv:** A blazing-fast Python package installer and dependency resolver.

    - **Alembic:** Database migrations tool.

## 🏗️ Project Structure

- `backend/`: Contains the FastAPI application.

- `frontend/`: Contains the Vue.js single-page application.

- `docker-compose-dev.yml`: Configuration for the development environment (hot-reloading, DB).

- `docker-compose.yml`: Configuration for the production environment.

- `Dockerfile.backend`: Instructions to build the backend Docker image.

- `.env.example`: A template for environment variables.

## ⚙️ Getting Started (Development)

1.  **Clone the repository:**

2.  **Create `.env` file:**

    Copy the example file and fill in your variables.

    ```bash

    cp .env.example .env

    ```

3.  **Start the services:**

    This command will build the Docker images and start the backend and PostgreSQL containers. The backend will have hot-reloading enabled.

    ```bash

    docker compose -f docker-compose-dev.yml up --build

    ```

4.  **Run frontend (coming soon):**

    Instructions for the frontend will be added here once the setup is complete.

The backend API will be available at `http://localhost:8000`. You can access the auto-generated documentation at `http://localhost:8000/docs`.