Skip to content

Repository files navigation

Task Management Backend API

Instruksi Menjalankan Project

1. Clone Repository

git clone https://github.com/cupski/TaskManagement-BE.git

2. Masuk ke Folder Backend

cd TaskManagement-BE/task-management-backend

3. Buat dan Aktifkan Virtual Environment (Disarankan)

Windows:

python -m venv venv
venv\Scripts\activate

Linux / macOS:

python3 -m venv venv
source venv/bin/activate

4. Install Dependencies

pip install -r requirements.txt

5. Konfigurasi Environment Variable

Salin file .env.example menjadi .env:

cp .env.example .env

Windows (jika cp tidak tersedia):

copy .env.example .env

Sesuaikan isi .env dengan konfigurasi database (Serta buat database "taskmanager_db" terlebih dahulu di lokal) dan secret key.

6. Jalankan Server

Seeding Database:

python init-db

uvicorn app.main:app --reload --port 8000

Entity Relationship Diagram (ERD)

Untuk struktur database, dapat dilihat ERD dengan dua cara:

1. Melihat Gambar ERD

Buka file:

Task_ERD.png

2. Menggunakan dbdiagram.io

Salin isi file:

Task_ERD_dbdiagram.txt

Lalu paste ke dbdiagram.io untuk melihat ERD secara interaktif.


Struktur Folder

task-management-backend/
├─ app/
│  ├─ models/            # Model database
│  ├─ routers/           # Endpoint API (auth, users, tasks)
│  ├─ schemas/           # Pydantic schemas
│  ├─ utils/             # Config, security, dependencies
│  └─ main.py            # Entry point FastAPI
├─ venv/                 # Virtual environment (Windows)
├─ Requirement.txt       # Dependency with version        
├─ .env.example          # Environment variables
├─ Task_ERD.png          # Diagram ERD (gambar)
├─ Task_ERD_dbdiagram.txt # Diagram ERD (sintaks dbdiagram)
├─ task-Management-API.postman_collection.json
└─ README.md

Testing API

Gunakan file Postman collection:

task-Management-API.postman_collection.json

Catatan

  • Backend menggunakan FastAPI
  • Autentikasi menggunakan JWT
  • Virtual environment (venv/) sudah disertakan untuk pengguna Windows
  • Pengguna Linux/macOS perlu membuat virtual environment baru

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages