mirror of
https://github.com/dat515-2025/Group-8.git
synced 2026-03-22 15:12:08 +01:00
Compare commits
24 Commits
merge/data
...
3b6b64d472
| Author | SHA1 | Date | |
|---|---|---|---|
| 3b6b64d472 | |||
|
|
9bc543a5fa | ||
|
|
14516a808b | ||
|
|
922ebf46ae | ||
| e200c73b47 | |||
|
|
ac10ab381e | ||
|
|
879109144c | ||
|
|
7061e57442 | ||
|
|
30068079c6 | ||
|
|
9580bea630 | ||
|
|
975f5e5bec | ||
|
|
f1065bc274 | ||
|
|
12152238c6 | ||
|
|
21ef5a3961 | ||
|
|
2f20fb12e4 | ||
| 95c8bf1e92 | |||
| b213f22a15 | |||
| 0cf06b7bd9 | |||
| 7a67b12533 | |||
| a91aea805f | |||
| 32764ab1b0 | |||
|
|
6c248039ac | ||
| df0f2584ae | |||
| b7570e334f |
@@ -5,4 +5,4 @@ COPY requirements.txt .
|
|||||||
RUN pip install --no-cache-dir -r requirements.txt
|
RUN pip install --no-cache-dir -r requirements.txt
|
||||||
COPY . .
|
COPY . .
|
||||||
EXPOSE 8000
|
EXPOSE 8000
|
||||||
CMD alembic upgrade head && uvicorn app.app:app --host 0.0.0.0 --port 8000
|
CMD alembic upgrade head && uvicorn app.app:fastApi --host 0.0.0.0 --port 8000
|
||||||
|
|||||||
@@ -0,0 +1,48 @@
|
|||||||
|
"""add user oauth
|
||||||
|
|
||||||
|
Revision ID: 7af8f296d089
|
||||||
|
Revises: 390041bd839e
|
||||||
|
Create Date: 2025-10-10 14:05:00.153376
|
||||||
|
|
||||||
|
"""
|
||||||
|
from typing import Sequence, Union
|
||||||
|
|
||||||
|
import fastapi_users_db_sqlalchemy
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = '7af8f296d089'
|
||||||
|
down_revision: Union[str, Sequence[str], None] = '390041bd839e'
|
||||||
|
branch_labels: Union[str, Sequence[str], None] = None
|
||||||
|
depends_on: Union[str, Sequence[str], None] = None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade schema."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.create_table('oauth_account',
|
||||||
|
sa.Column('id', fastapi_users_db_sqlalchemy.generics.GUID(), nullable=False),
|
||||||
|
sa.Column('user_id', fastapi_users_db_sqlalchemy.generics.GUID(), nullable=False),
|
||||||
|
sa.Column('oauth_name', sa.String(length=100), nullable=False),
|
||||||
|
sa.Column('access_token', sa.String(length=1024), nullable=False),
|
||||||
|
sa.Column('expires_at', sa.Integer(), nullable=True),
|
||||||
|
sa.Column('refresh_token', sa.String(length=1024), nullable=True),
|
||||||
|
sa.Column('account_id', sa.String(length=320), nullable=False),
|
||||||
|
sa.Column('account_email', sa.String(length=320), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(['user_id'], ['user.id'], ondelete='cascade'),
|
||||||
|
sa.PrimaryKeyConstraint('id')
|
||||||
|
)
|
||||||
|
op.create_index(op.f('ix_oauth_account_account_id'), 'oauth_account', ['account_id'], unique=False)
|
||||||
|
op.create_index(op.f('ix_oauth_account_oauth_name'), 'oauth_account', ['oauth_name'], unique=False)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade schema."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.drop_index(op.f('ix_oauth_account_oauth_name'), table_name='oauth_account')
|
||||||
|
op.drop_index(op.f('ix_oauth_account_account_id'), table_name='oauth_account')
|
||||||
|
op.drop_table('oauth_account')
|
||||||
|
# ### end Alembic commands ###
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
"""change token length
|
||||||
|
|
||||||
|
Revision ID: 5ab2e654c96e
|
||||||
|
Revises: 7af8f296d089
|
||||||
|
Create Date: 2025-10-11 21:07:41.930470
|
||||||
|
|
||||||
|
"""
|
||||||
|
from typing import Sequence, Union
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from sqlalchemy.dialects import mysql
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = '5ab2e654c96e'
|
||||||
|
down_revision: Union[str, Sequence[str], None] = '7af8f296d089'
|
||||||
|
branch_labels: Union[str, Sequence[str], None] = None
|
||||||
|
depends_on: Union[str, Sequence[str], None] = None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade schema."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.alter_column('oauth_account', 'access_token',
|
||||||
|
existing_type=mysql.VARCHAR(length=1024),
|
||||||
|
type_=sa.String(length=4096),
|
||||||
|
existing_nullable=False)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade schema."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.alter_column('oauth_account', 'access_token',
|
||||||
|
existing_type=sa.String(length=4096),
|
||||||
|
type_=mysql.VARCHAR(length=1024),
|
||||||
|
existing_nullable=False)
|
||||||
|
# ### end Alembic commands ###
|
||||||
31
7project/backend/app/api/auth.py
Normal file
31
7project/backend/app/api/auth.py
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
from fastapi import APIRouter
|
||||||
|
|
||||||
|
from app.schemas.user import UserCreate, UserRead, UserUpdate
|
||||||
|
from app.services.user_service import auth_backend, fastapi_users
|
||||||
|
|
||||||
|
router = APIRouter()
|
||||||
|
|
||||||
|
# Keep existing paths as-is under /auth/* and /users/*
|
||||||
|
router.include_router(
|
||||||
|
fastapi_users.get_auth_router(auth_backend), prefix="/auth/jwt", tags=["auth"]
|
||||||
|
)
|
||||||
|
router.include_router(
|
||||||
|
fastapi_users.get_register_router(UserRead, UserCreate),
|
||||||
|
prefix="/auth",
|
||||||
|
tags=["auth"],
|
||||||
|
)
|
||||||
|
router.include_router(
|
||||||
|
fastapi_users.get_reset_password_router(),
|
||||||
|
prefix="/auth",
|
||||||
|
tags=["auth"],
|
||||||
|
)
|
||||||
|
router.include_router(
|
||||||
|
fastapi_users.get_verify_router(UserRead),
|
||||||
|
prefix="/auth",
|
||||||
|
tags=["auth"],
|
||||||
|
)
|
||||||
|
router.include_router(
|
||||||
|
fastapi_users.get_users_router(UserRead, UserUpdate),
|
||||||
|
prefix="/users",
|
||||||
|
tags=["users"],
|
||||||
|
)
|
||||||
77
7project/backend/app/api/categories.py
Normal file
77
7project/backend/app/api/categories.py
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
from typing import List
|
||||||
|
|
||||||
|
from fastapi import APIRouter, Depends, HTTPException, status
|
||||||
|
from sqlalchemy import select, delete
|
||||||
|
from sqlalchemy.ext.asyncio import AsyncSession
|
||||||
|
|
||||||
|
from app.models.categories import Category
|
||||||
|
from app.schemas.category import CategoryCreate, CategoryRead
|
||||||
|
from app.services.db import get_async_session
|
||||||
|
from app.services.user_service import current_active_user
|
||||||
|
from app.models.user import User
|
||||||
|
|
||||||
|
router = APIRouter(prefix="/categories", tags=["categories"])
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/create", response_model=CategoryRead, status_code=status.HTTP_201_CREATED)
|
||||||
|
async def create_category(
|
||||||
|
payload: CategoryCreate,
|
||||||
|
session: AsyncSession = Depends(get_async_session),
|
||||||
|
user: User = Depends(current_active_user),
|
||||||
|
):
|
||||||
|
# Enforce per-user unique name via query to provide 409 feedback
|
||||||
|
res = await session.execute(
|
||||||
|
select(Category).where(Category.user_id == user.id, Category.name == payload.name)
|
||||||
|
)
|
||||||
|
existing = res.scalar_one_or_none()
|
||||||
|
if existing:
|
||||||
|
raise HTTPException(status_code=409, detail="Category with this name already exists")
|
||||||
|
|
||||||
|
category = Category(name=payload.name, description=payload.description, user_id=user.id)
|
||||||
|
session.add(category)
|
||||||
|
await session.commit()
|
||||||
|
await session.refresh(category)
|
||||||
|
return category
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/", response_model=List[CategoryRead])
|
||||||
|
async def list_categories(
|
||||||
|
session: AsyncSession = Depends(get_async_session),
|
||||||
|
user: User = Depends(current_active_user),
|
||||||
|
):
|
||||||
|
res = await session.execute(select(Category).where(Category.user_id == user.id))
|
||||||
|
return list(res.scalars())
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/{category_id}", response_model=CategoryRead)
|
||||||
|
async def get_category(
|
||||||
|
category_id: int,
|
||||||
|
session: AsyncSession = Depends(get_async_session),
|
||||||
|
user: User = Depends(current_active_user),
|
||||||
|
):
|
||||||
|
res = await session.execute(
|
||||||
|
select(Category).where(Category.id == category_id, Category.user_id == user.id)
|
||||||
|
)
|
||||||
|
category = res.scalar_one_or_none()
|
||||||
|
if not category:
|
||||||
|
raise HTTPException(status_code=404, detail="Category not found")
|
||||||
|
return category
|
||||||
|
|
||||||
|
|
||||||
|
@router.delete("/{category_id}", status_code=status.HTTP_204_NO_CONTENT)
|
||||||
|
async def delete_category(
|
||||||
|
category_id: int,
|
||||||
|
session: AsyncSession = Depends(get_async_session),
|
||||||
|
user: User = Depends(current_active_user),
|
||||||
|
):
|
||||||
|
res = await session.execute(
|
||||||
|
select(Category.id).where(Category.id == category_id, Category.user_id == user.id)
|
||||||
|
)
|
||||||
|
if res.scalar_one_or_none() is None:
|
||||||
|
raise HTTPException(status_code=404, detail="Category not found")
|
||||||
|
|
||||||
|
await session.execute(
|
||||||
|
delete(Category).where(Category.id == category_id, Category.user_id == user.id)
|
||||||
|
)
|
||||||
|
await session.commit()
|
||||||
|
return None
|
||||||
219
7project/backend/app/api/transactions.py
Normal file
219
7project/backend/app/api/transactions.py
Normal file
@@ -0,0 +1,219 @@
|
|||||||
|
from typing import List, Optional
|
||||||
|
|
||||||
|
from fastapi import APIRouter, Depends, HTTPException, status
|
||||||
|
from sqlalchemy import select
|
||||||
|
from sqlalchemy.ext.asyncio import AsyncSession
|
||||||
|
|
||||||
|
from app.models.transaction import Transaction
|
||||||
|
from app.models.categories import Category
|
||||||
|
from app.schemas.transaction import (
|
||||||
|
TransactionCreate,
|
||||||
|
TransactionRead,
|
||||||
|
TransactionUpdate,
|
||||||
|
)
|
||||||
|
from app.services.db import get_async_session
|
||||||
|
from app.services.user_service import current_active_user
|
||||||
|
from app.models.user import User
|
||||||
|
|
||||||
|
router = APIRouter(prefix="/transactions", tags=["transactions"])
|
||||||
|
|
||||||
|
|
||||||
|
def _to_read_model(tx: Transaction) -> TransactionRead:
|
||||||
|
return TransactionRead(
|
||||||
|
id=tx.id,
|
||||||
|
amount=tx.amount,
|
||||||
|
description=tx.description,
|
||||||
|
category_ids=[c.id for c in (tx.categories or [])],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/create", response_model=TransactionRead, status_code=status.HTTP_201_CREATED)
|
||||||
|
async def create_transaction(
|
||||||
|
payload: TransactionCreate,
|
||||||
|
session: AsyncSession = Depends(get_async_session),
|
||||||
|
user: User = Depends(current_active_user),
|
||||||
|
):
|
||||||
|
tx = Transaction(amount=payload.amount, description=payload.description, user_id=user.id)
|
||||||
|
|
||||||
|
# Attach categories if provided (and owned by user)
|
||||||
|
if payload.category_ids:
|
||||||
|
res = await session.execute(
|
||||||
|
select(Category).where(
|
||||||
|
Category.user_id == user.id, Category.id.in_(payload.category_ids)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
categories = list(res.scalars())
|
||||||
|
if len(categories) != len(set(payload.category_ids)):
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=400,
|
||||||
|
detail="Duplicate category IDs provided or one or more categories not found"
|
||||||
|
)
|
||||||
|
tx.categories = categories
|
||||||
|
|
||||||
|
session.add(tx)
|
||||||
|
await session.commit()
|
||||||
|
await session.refresh(tx)
|
||||||
|
# Ensure categories are loaded
|
||||||
|
await session.refresh(tx, attribute_names=["categories"])
|
||||||
|
return _to_read_model(tx)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/", response_model=List[TransactionRead])
|
||||||
|
async def list_transactions(
|
||||||
|
session: AsyncSession = Depends(get_async_session),
|
||||||
|
user: User = Depends(current_active_user),
|
||||||
|
):
|
||||||
|
res = await session.execute(
|
||||||
|
select(Transaction).where(Transaction.user_id == user.id).order_by(Transaction.id)
|
||||||
|
)
|
||||||
|
txs = list(res.scalars())
|
||||||
|
# Eagerly load categories for each transaction
|
||||||
|
for tx in txs:
|
||||||
|
await session.refresh(tx, attribute_names=["categories"])
|
||||||
|
return [_to_read_model(tx) for tx in txs]
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/{transaction_id}", response_model=TransactionRead)
|
||||||
|
async def get_transaction(
|
||||||
|
transaction_id: int,
|
||||||
|
session: AsyncSession = Depends(get_async_session),
|
||||||
|
user: User = Depends(current_active_user),
|
||||||
|
):
|
||||||
|
res = await session.execute(
|
||||||
|
select(Transaction).where(
|
||||||
|
Transaction.id == transaction_id, Transaction.user_id == user.id
|
||||||
|
)
|
||||||
|
)
|
||||||
|
tx: Optional[Transaction] = res.scalar_one_or_none()
|
||||||
|
if not tx:
|
||||||
|
raise HTTPException(status_code=404, detail="Transaction not found")
|
||||||
|
await session.refresh(tx, attribute_names=["categories"])
|
||||||
|
return _to_read_model(tx)
|
||||||
|
|
||||||
|
|
||||||
|
@router.patch("/{transaction_id}/edit", response_model=TransactionRead)
|
||||||
|
async def update_transaction(
|
||||||
|
transaction_id: int,
|
||||||
|
payload: TransactionUpdate,
|
||||||
|
session: AsyncSession = Depends(get_async_session),
|
||||||
|
user: User = Depends(current_active_user),
|
||||||
|
):
|
||||||
|
res = await session.execute(
|
||||||
|
select(Transaction).where(
|
||||||
|
Transaction.id == transaction_id, Transaction.user_id == user.id
|
||||||
|
)
|
||||||
|
)
|
||||||
|
tx: Optional[Transaction] = res.scalar_one_or_none()
|
||||||
|
if not tx:
|
||||||
|
raise HTTPException(status_code=404, detail="Transaction not found")
|
||||||
|
|
||||||
|
if payload.amount is not None:
|
||||||
|
tx.amount = payload.amount
|
||||||
|
if payload.description is not None:
|
||||||
|
tx.description = payload.description
|
||||||
|
|
||||||
|
if payload.category_ids is not None:
|
||||||
|
# Preload categories to avoid async lazy-load during assignment
|
||||||
|
await session.refresh(tx, attribute_names=["categories"])
|
||||||
|
if payload.category_ids:
|
||||||
|
# Check for duplicate category IDs in the payload
|
||||||
|
if len(payload.category_ids) != len(set(payload.category_ids)):
|
||||||
|
raise HTTPException(status_code=400, detail="Duplicate category IDs in payload")
|
||||||
|
res = await session.execute(
|
||||||
|
select(Category).where(
|
||||||
|
Category.user_id == user.id, Category.id.in_(payload.category_ids)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
categories = list(res.scalars())
|
||||||
|
if len(categories) != len(payload.category_ids):
|
||||||
|
raise HTTPException(status_code=400, detail="One or more categories not found")
|
||||||
|
tx.categories = categories
|
||||||
|
else:
|
||||||
|
tx.categories = []
|
||||||
|
|
||||||
|
await session.commit()
|
||||||
|
await session.refresh(tx, attribute_names=["categories"])
|
||||||
|
return _to_read_model(tx)
|
||||||
|
|
||||||
|
|
||||||
|
@router.delete("/{transaction_id}/delete", status_code=status.HTTP_204_NO_CONTENT)
|
||||||
|
async def delete_transaction(
|
||||||
|
transaction_id: int,
|
||||||
|
session: AsyncSession = Depends(get_async_session),
|
||||||
|
user: User = Depends(current_active_user),
|
||||||
|
):
|
||||||
|
res = await session.execute(
|
||||||
|
select(Transaction).where(
|
||||||
|
Transaction.id == transaction_id, Transaction.user_id == user.id
|
||||||
|
)
|
||||||
|
)
|
||||||
|
tx = res.scalar_one_or_none()
|
||||||
|
if not tx:
|
||||||
|
raise HTTPException(status_code=404, detail="Transaction not found")
|
||||||
|
|
||||||
|
await session.delete(tx)
|
||||||
|
await session.commit()
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/{transaction_id}/categories/{category_id}", response_model=TransactionRead)
|
||||||
|
async def assign_category(
|
||||||
|
transaction_id: int,
|
||||||
|
category_id: int,
|
||||||
|
session: AsyncSession = Depends(get_async_session),
|
||||||
|
user: User = Depends(current_active_user),
|
||||||
|
):
|
||||||
|
# Load transaction and category ensuring ownership
|
||||||
|
res_tx = await session.execute(
|
||||||
|
select(Transaction).where(
|
||||||
|
Transaction.id == transaction_id, Transaction.user_id == user.id
|
||||||
|
)
|
||||||
|
)
|
||||||
|
tx: Optional[Transaction] = res_tx.scalar_one_or_none()
|
||||||
|
if not tx:
|
||||||
|
raise HTTPException(status_code=404, detail="Transaction not found")
|
||||||
|
|
||||||
|
res_cat = await session.execute(
|
||||||
|
select(Category).where(Category.id == category_id, Category.user_id == user.id)
|
||||||
|
)
|
||||||
|
cat: Optional[Category] = res_cat.scalar_one_or_none()
|
||||||
|
if not cat:
|
||||||
|
raise HTTPException(status_code=404, detail="Category not found")
|
||||||
|
|
||||||
|
await session.refresh(tx, attribute_names=["categories"])
|
||||||
|
if cat not in tx.categories:
|
||||||
|
tx.categories.append(cat)
|
||||||
|
await session.commit()
|
||||||
|
await session.refresh(tx, attribute_names=["categories"])
|
||||||
|
return _to_read_model(tx)
|
||||||
|
|
||||||
|
|
||||||
|
@router.delete("/{transaction_id}/categories/{category_id}", response_model=TransactionRead)
|
||||||
|
async def unassign_category(
|
||||||
|
transaction_id: int,
|
||||||
|
category_id: int,
|
||||||
|
session: AsyncSession = Depends(get_async_session),
|
||||||
|
user: User = Depends(current_active_user),
|
||||||
|
):
|
||||||
|
res_tx = await session.execute(
|
||||||
|
select(Transaction).where(
|
||||||
|
Transaction.id == transaction_id, Transaction.user_id == user.id
|
||||||
|
)
|
||||||
|
)
|
||||||
|
tx: Optional[Transaction] = res_tx.scalar_one_or_none()
|
||||||
|
if not tx:
|
||||||
|
raise HTTPException(status_code=404, detail="Transaction not found")
|
||||||
|
|
||||||
|
res_cat = await session.execute(
|
||||||
|
select(Category).where(Category.id == category_id, Category.user_id == user.id)
|
||||||
|
)
|
||||||
|
cat: Optional[Category] = res_cat.scalar_one_or_none()
|
||||||
|
if not cat:
|
||||||
|
raise HTTPException(status_code=404, detail="Category not found")
|
||||||
|
|
||||||
|
await session.refresh(tx, attribute_names=["categories"])
|
||||||
|
if cat in tx.categories:
|
||||||
|
tx.categories.remove(cat)
|
||||||
|
await session.commit()
|
||||||
|
await session.refresh(tx, attribute_names=["categories"])
|
||||||
|
return _to_read_model(tx)
|
||||||
@@ -3,13 +3,16 @@ from fastapi.middleware.cors import CORSMiddleware
|
|||||||
|
|
||||||
from app.models.user import User
|
from app.models.user import User
|
||||||
|
|
||||||
from app.schemas.user import UserCreate, UserRead, UserUpdate
|
from app.services.user_service import current_active_verified_user
|
||||||
from app.services.user_service import auth_backend, current_active_verified_user, fastapi_users
|
from app.api.auth import router as auth_router
|
||||||
|
from app.api.categories import router as categories_router
|
||||||
|
from app.api.transactions import router as transactions_router
|
||||||
|
from app.services.user_service import auth_backend, current_active_verified_user, fastapi_users, get_oauth_provider
|
||||||
|
|
||||||
app = FastAPI()
|
fastApi = FastAPI()
|
||||||
|
|
||||||
# CORS for frontend dev server
|
# CORS for frontend dev server
|
||||||
app.add_middleware(
|
fastApi.add_middleware(
|
||||||
CORSMiddleware,
|
CORSMiddleware,
|
||||||
allow_origins=[
|
allow_origins=[
|
||||||
"http://localhost:5173",
|
"http://localhost:5173",
|
||||||
@@ -20,37 +23,39 @@ app.add_middleware(
|
|||||||
allow_headers=["*"],
|
allow_headers=["*"],
|
||||||
)
|
)
|
||||||
|
|
||||||
app.include_router(
|
fastApi.include_router(auth_router)
|
||||||
fastapi_users.get_auth_router(auth_backend), prefix="/auth/jwt", tags=["auth"]
|
fastApi.include_router(categories_router)
|
||||||
)
|
fastApi.include_router(transactions_router)
|
||||||
app.include_router(
|
|
||||||
fastapi_users.get_register_router(UserRead, UserCreate),
|
fastApi.include_router(
|
||||||
prefix="/auth",
|
fastapi_users.get_oauth_router(
|
||||||
|
get_oauth_provider("MojeID"),
|
||||||
|
auth_backend,
|
||||||
|
"SECRET",
|
||||||
|
associate_by_email=True,
|
||||||
|
),
|
||||||
|
prefix="/auth/mojeid",
|
||||||
tags=["auth"],
|
tags=["auth"],
|
||||||
)
|
)
|
||||||
app.include_router(
|
|
||||||
fastapi_users.get_reset_password_router(),
|
fastApi.include_router(
|
||||||
prefix="/auth",
|
fastapi_users.get_oauth_router(
|
||||||
|
get_oauth_provider("BankID"),
|
||||||
|
auth_backend,
|
||||||
|
"SECRET",
|
||||||
|
associate_by_email=True,
|
||||||
|
),
|
||||||
|
prefix="/auth/bankid",
|
||||||
tags=["auth"],
|
tags=["auth"],
|
||||||
)
|
)
|
||||||
app.include_router(
|
|
||||||
fastapi_users.get_verify_router(UserRead),
|
|
||||||
prefix="/auth",
|
|
||||||
tags=["auth"],
|
|
||||||
)
|
|
||||||
app.include_router(
|
|
||||||
fastapi_users.get_users_router(UserRead, UserUpdate),
|
|
||||||
prefix="/users",
|
|
||||||
tags=["users"],
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# Liveness/root endpoint
|
# Liveness/root endpoint
|
||||||
@app.get("/", include_in_schema=False)
|
@fastApi.get("/", include_in_schema=False)
|
||||||
async def root():
|
async def root():
|
||||||
return {"status": "ok"}
|
return {"status": "ok"}
|
||||||
|
|
||||||
|
|
||||||
@app.get("/authenticated-route")
|
@fastApi.get("/authenticated-route")
|
||||||
async def authenticated_route(user: User = Depends(current_active_verified_user)):
|
async def authenticated_route(user: User = Depends(current_active_verified_user)):
|
||||||
return {"message": f"Hello {user.email}!"}
|
return {"message": f"Hello {user.email}!"}
|
||||||
|
|||||||
@@ -1,13 +1,19 @@
|
|||||||
from sqlalchemy import Column, String
|
from sqlalchemy import Column, String
|
||||||
from sqlalchemy.orm import relationship
|
from sqlalchemy.orm import relationship, mapped_column, Mapped
|
||||||
from fastapi_users.db import SQLAlchemyBaseUserTableUUID
|
from fastapi_users.db import SQLAlchemyBaseUserTableUUID, SQLAlchemyBaseOAuthAccountTableUUID
|
||||||
from app.core.base import Base
|
from app.core.base import Base
|
||||||
|
|
||||||
|
|
||||||
|
class OAuthAccount(SQLAlchemyBaseOAuthAccountTableUUID, Base):
|
||||||
|
# BankID token is longer than default
|
||||||
|
access_token: Mapped[str] = mapped_column(String(length=4096), nullable=False)
|
||||||
|
|
||||||
|
|
||||||
class User(SQLAlchemyBaseUserTableUUID, Base):
|
class User(SQLAlchemyBaseUserTableUUID, Base):
|
||||||
first_name = Column(String(length=100), nullable=True)
|
first_name = Column(String(length=100), nullable=True)
|
||||||
last_name = Column(String(length=100), nullable=True)
|
last_name = Column(String(length=100), nullable=True)
|
||||||
|
oauth_accounts = relationship("OAuthAccount", lazy="joined")
|
||||||
|
|
||||||
# Relationship
|
# Relationship
|
||||||
transactions = relationship("Transaction", back_populates="user")
|
transactions = relationship("Transaction", back_populates="user")
|
||||||
categories = relationship("Category", back_populates="user")
|
categories = relationship("Category", back_populates="user")
|
||||||
|
|||||||
0
7project/backend/app/oauth/__init__.py
Normal file
0
7project/backend/app/oauth/__init__.py
Normal file
50
7project/backend/app/oauth/bank_id.py
Normal file
50
7project/backend/app/oauth/bank_id.py
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
import secrets
|
||||||
|
from typing import Optional, Literal
|
||||||
|
|
||||||
|
from httpx_oauth.oauth2 import T
|
||||||
|
|
||||||
|
from app.oauth.custom_openid import CustomOpenID
|
||||||
|
|
||||||
|
|
||||||
|
class BankID(CustomOpenID):
|
||||||
|
def __init__(self, client_id: str, client_secret: str):
|
||||||
|
super().__init__(
|
||||||
|
client_id,
|
||||||
|
client_secret,
|
||||||
|
"https://oidc.sandbox.bankid.cz/.well-known/openid-configuration",
|
||||||
|
"BankID",
|
||||||
|
base_scopes=["openid", "profile.email", "profile.name"],
|
||||||
|
)
|
||||||
|
|
||||||
|
async def get_user_info(self, token: str) -> dict:
|
||||||
|
info = await self.get_profile(token)
|
||||||
|
|
||||||
|
return {
|
||||||
|
"first_name": info.get("given_name"),
|
||||||
|
"last_name": info.get("family_name"),
|
||||||
|
}
|
||||||
|
|
||||||
|
async def get_authorization_url(
|
||||||
|
self,
|
||||||
|
redirect_uri: str,
|
||||||
|
state: Optional[str] = None,
|
||||||
|
scope: Optional[list[str]] = None,
|
||||||
|
code_challenge: Optional[str] = None,
|
||||||
|
code_challenge_method: Optional[Literal["plain", "S256"]] = None,
|
||||||
|
extras_params: Optional[T] = None,
|
||||||
|
) -> str:
|
||||||
|
if extras_params is None:
|
||||||
|
extras_params = {}
|
||||||
|
|
||||||
|
# BankID requires random nonce parameter for security
|
||||||
|
# https://developer.bankid.cz/docs/security_sep
|
||||||
|
extras_params["nonce"] = secrets.token_urlsafe()
|
||||||
|
|
||||||
|
return await super().get_authorization_url(
|
||||||
|
redirect_uri,
|
||||||
|
state,
|
||||||
|
scope,
|
||||||
|
code_challenge,
|
||||||
|
code_challenge_method,
|
||||||
|
extras_params,
|
||||||
|
)
|
||||||
6
7project/backend/app/oauth/custom_openid.py
Normal file
6
7project/backend/app/oauth/custom_openid.py
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
from httpx_oauth.clients.openid import OpenID
|
||||||
|
|
||||||
|
|
||||||
|
class CustomOpenID(OpenID):
|
||||||
|
async def get_user_info(self, token: str) -> dict:
|
||||||
|
raise NotImplementedError()
|
||||||
56
7project/backend/app/oauth/moje_id.py
Normal file
56
7project/backend/app/oauth/moje_id.py
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
import json
|
||||||
|
from typing import Optional, Literal, Any
|
||||||
|
|
||||||
|
from httpx_oauth.oauth2 import T
|
||||||
|
|
||||||
|
from app.oauth.custom_openid import CustomOpenID
|
||||||
|
|
||||||
|
|
||||||
|
class MojeIDOAuth(CustomOpenID):
|
||||||
|
def __init__(self, client_id: str, client_secret: str):
|
||||||
|
super().__init__(
|
||||||
|
client_id,
|
||||||
|
client_secret,
|
||||||
|
"https://mojeid.regtest.nic.cz/.well-known/openid-configuration/",
|
||||||
|
"MojeID",
|
||||||
|
base_scopes=["openid", "email", "profile"],
|
||||||
|
)
|
||||||
|
|
||||||
|
async def get_user_info(self, token: str) -> Optional[Any]:
|
||||||
|
info = await self.get_profile(token)
|
||||||
|
|
||||||
|
return {
|
||||||
|
"first_name": info.get("given_name"),
|
||||||
|
"last_name": info.get("family_name"),
|
||||||
|
}
|
||||||
|
|
||||||
|
async def get_authorization_url(
|
||||||
|
self,
|
||||||
|
redirect_uri: str,
|
||||||
|
state: Optional[str] = None,
|
||||||
|
scope: Optional[list[str]] = None,
|
||||||
|
code_challenge: Optional[str] = None,
|
||||||
|
code_challenge_method: Optional[Literal["plain", "S256"]] = None,
|
||||||
|
extras_params: Optional[T] = None,
|
||||||
|
) -> str:
|
||||||
|
required_fields = {
|
||||||
|
'id_token': {
|
||||||
|
'name': {'essential': True},
|
||||||
|
'given_name': {'essential': True},
|
||||||
|
'family_name': {'essential': True},
|
||||||
|
'email': {'essential': True},
|
||||||
|
'mojeid_valid': {'essential': True},
|
||||||
|
}}
|
||||||
|
|
||||||
|
if extras_params is None:
|
||||||
|
extras_params = {}
|
||||||
|
extras_params["claims"] = json.dumps(required_fields)
|
||||||
|
|
||||||
|
return await super().get_authorization_url(
|
||||||
|
redirect_uri,
|
||||||
|
state,
|
||||||
|
scope,
|
||||||
|
code_challenge,
|
||||||
|
code_challenge_method,
|
||||||
|
extras_params,
|
||||||
|
)
|
||||||
16
7project/backend/app/schemas/category.py
Normal file
16
7project/backend/app/schemas/category.py
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
from typing import Optional
|
||||||
|
from pydantic import BaseModel, ConfigDict
|
||||||
|
|
||||||
|
|
||||||
|
class CategoryBase(BaseModel):
|
||||||
|
name: str
|
||||||
|
description: Optional[str] = None
|
||||||
|
|
||||||
|
|
||||||
|
class CategoryCreate(CategoryBase):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class CategoryRead(CategoryBase):
|
||||||
|
id: int
|
||||||
|
model_config = ConfigDict(from_attributes=True)
|
||||||
21
7project/backend/app/schemas/transaction.py
Normal file
21
7project/backend/app/schemas/transaction.py
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
from typing import List, Optional
|
||||||
|
from pydantic import BaseModel, Field, ConfigDict
|
||||||
|
|
||||||
|
|
||||||
|
class TransactionBase(BaseModel):
|
||||||
|
amount: float = Field(..., gt=-1e18, lt=1e18)
|
||||||
|
description: Optional[str] = None
|
||||||
|
|
||||||
|
class TransactionCreate(TransactionBase):
|
||||||
|
category_ids: Optional[List[int]] = None
|
||||||
|
|
||||||
|
class TransactionUpdate(BaseModel):
|
||||||
|
amount: Optional[float] = Field(None, gt=-1e18, lt=1e18)
|
||||||
|
description: Optional[str] = None
|
||||||
|
category_ids: Optional[List[int]] = None
|
||||||
|
|
||||||
|
class TransactionRead(TransactionBase):
|
||||||
|
id: int
|
||||||
|
category_ids: List[int] = []
|
||||||
|
|
||||||
|
model_config = ConfigDict(from_attributes=True)
|
||||||
@@ -4,13 +4,13 @@ from fastapi_users import schemas
|
|||||||
|
|
||||||
class UserRead(schemas.BaseUser[uuid.UUID]):
|
class UserRead(schemas.BaseUser[uuid.UUID]):
|
||||||
first_name: Optional[str] = None
|
first_name: Optional[str] = None
|
||||||
surname: Optional[str] = None
|
last_name: Optional[str] = None
|
||||||
|
|
||||||
class UserCreate(schemas.BaseUserCreate):
|
class UserCreate(schemas.BaseUserCreate):
|
||||||
first_name: Optional[str] = None
|
first_name: Optional[str] = None
|
||||||
surname: Optional[str] = None
|
last_name: Optional[str] = None
|
||||||
|
|
||||||
class UserUpdate(schemas.BaseUserUpdate):
|
class UserUpdate(schemas.BaseUserUpdate):
|
||||||
first_name: Optional[str] = None
|
first_name: Optional[str] = None
|
||||||
surname: Optional[str] = None
|
last_name: Optional[str] = None
|
||||||
|
|
||||||
|
|||||||
@@ -4,11 +4,13 @@ from sqlalchemy.ext.asyncio import AsyncSession
|
|||||||
from fastapi_users.db import SQLAlchemyUserDatabase
|
from fastapi_users.db import SQLAlchemyUserDatabase
|
||||||
|
|
||||||
from ..core.db import async_session_maker
|
from ..core.db import async_session_maker
|
||||||
from ..models.user import User
|
from ..models.user import User, OAuthAccount
|
||||||
|
|
||||||
|
|
||||||
async def get_async_session() -> AsyncGenerator[AsyncSession, None]:
|
async def get_async_session() -> AsyncGenerator[AsyncSession, None]:
|
||||||
async with async_session_maker() as session:
|
async with async_session_maker() as session:
|
||||||
yield session
|
yield session
|
||||||
|
|
||||||
|
|
||||||
async def get_user_db(session: AsyncSession = Depends(get_async_session)):
|
async def get_user_db(session: AsyncSession = Depends(get_async_session)):
|
||||||
yield SQLAlchemyUserDatabase(session, User)
|
yield SQLAlchemyUserDatabase(session, User, OAuthAccount)
|
||||||
|
|||||||
@@ -3,26 +3,66 @@ import uuid
|
|||||||
from typing import Optional
|
from typing import Optional
|
||||||
|
|
||||||
from fastapi import Depends, Request
|
from fastapi import Depends, Request
|
||||||
from fastapi_users import BaseUserManager, FastAPIUsers, UUIDIDMixin
|
from fastapi_users import BaseUserManager, FastAPIUsers, UUIDIDMixin, models
|
||||||
from fastapi_users.authentication import (
|
from fastapi_users.authentication import (
|
||||||
AuthenticationBackend,
|
AuthenticationBackend,
|
||||||
BearerTransport,
|
BearerTransport,
|
||||||
)
|
)
|
||||||
from fastapi_users.authentication.strategy.jwt import JWTStrategy
|
from fastapi_users.authentication.strategy.jwt import JWTStrategy
|
||||||
from fastapi_users.db import SQLAlchemyUserDatabase
|
from fastapi_users.db import SQLAlchemyUserDatabase
|
||||||
|
from httpx_oauth.oauth2 import BaseOAuth2
|
||||||
|
|
||||||
from app.models.user import User
|
from app.models.user import User
|
||||||
|
from app.oauth.bank_id import BankID
|
||||||
|
from app.oauth.custom_openid import CustomOpenID
|
||||||
|
from app.oauth.moje_id import MojeIDOAuth
|
||||||
from app.services.db import get_user_db
|
from app.services.db import get_user_db
|
||||||
from app.core.queue import enqueue_email
|
from app.core.queue import enqueue_email
|
||||||
|
|
||||||
SECRET = os.getenv("SECRET", "CHANGE_ME_SECRET")
|
SECRET = os.getenv("SECRET", "CHANGE_ME_SECRET")
|
||||||
|
|
||||||
FRONTEND_URL = os.getenv("FRONTEND_URL", "http://localhost:5173")
|
FRONTEND_URL = os.getenv("FRONTEND_URL", "http://localhost:5173")
|
||||||
BACKEND_URL = os.getenv("BACKEND_URL", "http://localhost:8000")
|
BACKEND_URL = os.getenv("BACKEND_URL", "http://localhost:8000")
|
||||||
|
|
||||||
|
providers = {
|
||||||
|
"MojeID": MojeIDOAuth(
|
||||||
|
os.getenv("MOJEID_CLIENT_ID", "CHANGE_ME_CLIENT_ID"),
|
||||||
|
os.getenv("MOJEID_CLIENT_SECRET", "CHANGE_ME_CLIENT_SECRET"),
|
||||||
|
),
|
||||||
|
"BankID": BankID(
|
||||||
|
os.getenv("BANKID_CLIENT_ID", "CHANGE_ME_CLIENT_ID"),
|
||||||
|
os.getenv("BANKID_CLIENT_SECRET", "CHANGE_ME_CLIENT_SECRET"),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def get_oauth_provider(name: str) -> Optional[BaseOAuth2]:
|
||||||
|
if name not in providers:
|
||||||
|
return None
|
||||||
|
return providers[name]
|
||||||
|
|
||||||
|
|
||||||
class UserManager(UUIDIDMixin, BaseUserManager[User, uuid.UUID]):
|
class UserManager(UUIDIDMixin, BaseUserManager[User, uuid.UUID]):
|
||||||
reset_password_token_secret = SECRET
|
reset_password_token_secret = SECRET
|
||||||
verification_token_secret = SECRET
|
verification_token_secret = SECRET
|
||||||
|
|
||||||
|
async def oauth_callback(self: "BaseUserManager[models.UOAP, models.ID]", oauth_name: str, access_token: str,
|
||||||
|
account_id: str, account_email: str, expires_at: Optional[int] = None,
|
||||||
|
refresh_token: Optional[str] = None, request: Optional[Request] = None, *,
|
||||||
|
associate_by_email: bool = False, is_verified_by_default: bool = False) -> models.UOAP:
|
||||||
|
|
||||||
|
user = await super().oauth_callback(oauth_name, access_token, account_id, account_email, expires_at,
|
||||||
|
refresh_token, request, associate_by_email=associate_by_email,
|
||||||
|
is_verified_by_default=is_verified_by_default)
|
||||||
|
|
||||||
|
# set additional user info from the OAuth provider
|
||||||
|
provider = get_oauth_provider(oauth_name)
|
||||||
|
if provider is not None and isinstance(provider, CustomOpenID):
|
||||||
|
update_dict = await provider.get_user_info(access_token)
|
||||||
|
await self.user_db.update(user, update_dict)
|
||||||
|
|
||||||
|
return user
|
||||||
|
|
||||||
async def on_after_register(self, user: User, request: Optional[Request] = None):
|
async def on_after_register(self, user: User, request: Optional[Request] = None):
|
||||||
await self.request_verify(user, request)
|
await self.request_verify(user, request)
|
||||||
|
|
||||||
@@ -52,14 +92,18 @@ class UserManager(UUIDIDMixin, BaseUserManager[User, uuid.UUID]):
|
|||||||
print("[Email Fallback] Subject:", subject)
|
print("[Email Fallback] Subject:", subject)
|
||||||
print("[Email Fallback] Body:\n", body)
|
print("[Email Fallback] Body:\n", body)
|
||||||
|
|
||||||
|
|
||||||
async def get_user_manager(user_db: SQLAlchemyUserDatabase = Depends(get_user_db)):
|
async def get_user_manager(user_db: SQLAlchemyUserDatabase = Depends(get_user_db)):
|
||||||
yield UserManager(user_db)
|
yield UserManager(user_db)
|
||||||
|
|
||||||
|
|
||||||
bearer_transport = BearerTransport(tokenUrl="auth/jwt/login")
|
bearer_transport = BearerTransport(tokenUrl="auth/jwt/login")
|
||||||
|
|
||||||
|
|
||||||
def get_jwt_strategy() -> JWTStrategy:
|
def get_jwt_strategy() -> JWTStrategy:
|
||||||
return JWTStrategy(secret=SECRET, lifetime_seconds=3600)
|
return JWTStrategy(secret=SECRET, lifetime_seconds=3600)
|
||||||
|
|
||||||
|
|
||||||
auth_backend = AuthenticationBackend(
|
auth_backend = AuthenticationBackend(
|
||||||
name="jwt",
|
name="jwt",
|
||||||
transport=bearer_transport,
|
transport=bearer_transport,
|
||||||
@@ -70,4 +114,3 @@ fastapi_users = FastAPIUsers[User, uuid.UUID](get_user_manager, [auth_backend])
|
|||||||
|
|
||||||
current_active_user = fastapi_users.current_user(active=True)
|
current_active_user = fastapi_users.current_user(active=True)
|
||||||
current_active_verified_user = fastapi_users.current_user(active=True, verified=True)
|
current_active_verified_user = fastapi_users.current_user(active=True, verified=True)
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ asyncmy==0.2.9
|
|||||||
bcrypt==4.3.0
|
bcrypt==4.3.0
|
||||||
billiard==4.2.2
|
billiard==4.2.2
|
||||||
celery==5.5.3
|
celery==5.5.3
|
||||||
|
certifi==2025.10.5
|
||||||
cffi==2.0.0
|
cffi==2.0.0
|
||||||
click==8.1.8
|
click==8.1.8
|
||||||
click-didyoumean==0.3.1
|
click-didyoumean==0.3.1
|
||||||
@@ -25,7 +26,10 @@ fastapi-users==14.0.1
|
|||||||
fastapi-users-db-sqlalchemy==7.0.0
|
fastapi-users-db-sqlalchemy==7.0.0
|
||||||
greenlet==3.2.4
|
greenlet==3.2.4
|
||||||
h11==0.16.0
|
h11==0.16.0
|
||||||
|
httpcore==1.0.9
|
||||||
httptools==0.6.4
|
httptools==0.6.4
|
||||||
|
httpx==0.28.1
|
||||||
|
httpx-oauth==0.16.1
|
||||||
idna==3.10
|
idna==3.10
|
||||||
kombu==5.5.4
|
kombu==5.5.4
|
||||||
makefun==1.16.0
|
makefun==1.16.0
|
||||||
|
|||||||
53
7project/meetings/2025-10-16-meeting.md
Normal file
53
7project/meetings/2025-10-16-meeting.md
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
# Weekly Meeting Notes
|
||||||
|
|
||||||
|
- Group 8 - Personal finance tracker
|
||||||
|
- Mentor: Jaychander
|
||||||
|
|
||||||
|
Keep all meeting notes in the `meetings.md` file in your project folder.
|
||||||
|
Just copy the template below for each weekly meeting and fill in the details.
|
||||||
|
|
||||||
|
## Administrative Info
|
||||||
|
|
||||||
|
- Date: 2025-10-08
|
||||||
|
- Attendees: Dejan Ribarovski, Lukas Trkan
|
||||||
|
- Notetaker: Dejan Ribarovski
|
||||||
|
|
||||||
|
## Progress Update (Before Meeting)
|
||||||
|
|
||||||
|
Summary of what has been accomplished since the last meeting in the following categories.
|
||||||
|
|
||||||
|
## Action Items from Last Week (During Meeting)
|
||||||
|
|
||||||
|
- [x] start coding the app logic
|
||||||
|
- [x] start writing the report so it matches the actual progress
|
||||||
|
- [x] redo the system diagram so it includes a response flow
|
||||||
|
|
||||||
|
### Coding
|
||||||
|
Implemented initial functioning version of the app, added OAuth with BankId and MojeID,
|
||||||
|
added database snapshots.
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
report.md is up to date
|
||||||
|
|
||||||
|
## Questions and Topics for Discussion (Before Meeting)
|
||||||
|
|
||||||
|
Prepare 3-5 questions and topics you want to discuss with your mentor.
|
||||||
|
|
||||||
|
1. What other functionality should be added to the app
|
||||||
|
2. Priority for the next week (Testing maybe?)
|
||||||
|
3. Question 3
|
||||||
|
|
||||||
|
## Discussion Notes (During Meeting)
|
||||||
|
|
||||||
|
## Action Items for Next Week (During Meeting)
|
||||||
|
|
||||||
|
Last 3 minutes of the meeting, summarize action items.
|
||||||
|
|
||||||
|
- [ ] OAuth
|
||||||
|
- [ ] CI/CD fix
|
||||||
|
- [ ] Database local (multiple bank accounts)
|
||||||
|
- [ ] Add tests and set up github pipeline
|
||||||
|
- [ ] Frontend imporvment - user experience
|
||||||
|
- [ ] make the report more clear
|
||||||
|
|
||||||
|
---
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# Project Report
|
# Personal finance tracker
|
||||||
|
|
||||||
> **Instructions**:
|
> **Instructions**:
|
||||||
> This template provides the structure for your project report.
|
> This template provides the structure for your project report.
|
||||||
@@ -7,126 +7,211 @@
|
|||||||
|
|
||||||
## Project Overview
|
## Project Overview
|
||||||
|
|
||||||
**Project Name**: [Your project name]
|
**Project Name**: Personal Finance Tracker
|
||||||
|
|
||||||
**Group Members**:
|
**Group Members**:
|
||||||
|
|
||||||
- Student number, Name, GitHub username
|
- 289229, Lukáš Trkan, lukastrkan
|
||||||
- Student number, Name, GitHub username
|
- 289258, Dejan Ribarovski, derib2613, ribardej
|
||||||
- Student number, Name, GitHub username
|
|
||||||
|
|
||||||
**Brief Description**:
|
**Brief Description**:
|
||||||
[2-3 sentences describing what your application does and its main purpose]
|
Our application is a finance tracker, so a person can easily track his cash flow
|
||||||
|
through multiple bank accounts. Person can label transactions with custom categories
|
||||||
|
and later filter by them.
|
||||||
|
|
||||||
## Architecture Overview
|
## Architecture Overview
|
||||||
|
Our system is a full‑stack web application composed of a React frontend, a FastAPI backend, a PostgreSQL database, and asynchronous background workers powered by Celery with RabbitMQ. Redis is available for caching/kv and may be used by Celery as a result backend. The backend exposes REST endpoints for authentication (email/password and OAuth), users, categories, and transactions. A thin controller layer (FastAPI routers) lives under app/api. Infrastructure for Kubernetes is provided via OpenTofu (Terraform‑compatible) modules and the application is packaged via a Helm chart.
|
||||||
|
|
||||||
### High-Level Architecture
|
### High-Level Architecture
|
||||||
|
|
||||||
[Describe the overall system architecture. Consider including a diagram using mermaid or linking to an image]
|
|
||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
graph TD
|
flowchart LR
|
||||||
A[Component A] --> B[Component B]
|
proc_queue[Message Queue] --> proc_queue_worker[Worker Service]
|
||||||
B --> C[Component C]
|
proc_queue_worker --> ext_mail[(Email Service)]
|
||||||
|
proc_cron[Task planner] --> proc_queue
|
||||||
|
proc_queue_worker --> ext_bank[(Bank API)]
|
||||||
|
proc_queue_worker --> db
|
||||||
|
client[Client/Frontend] <--> svc[Backend API]
|
||||||
|
svc --> proc_queue
|
||||||
|
svc <--> db[(Database)]
|
||||||
|
svc <--> cache[(Cache)]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Components
|
### Components
|
||||||
|
|
||||||
- **Component 1**: [Description of what this component does]
|
- Frontend (frontend/): React + TypeScript app built with Vite. Talks to the backend via REST, handles login/registration, shows latest transactions, filtering, and allows adding transactions.
|
||||||
- **Component 2**: [Description of what this component does]
|
- Backend API (backend/app): FastAPI app with routers under app/api for auth, categories, and transactions. Uses FastAPI Users for auth (JWT + OAuth), SQLAlchemy ORM, and Pydantic v2 schemas.
|
||||||
- **Component 3**: [Description of what this component does]
|
- Worker service (backend/app/workers): Celery worker handling asynchronous tasks (e.g., sending verification emails, future background processing).
|
||||||
|
- Database (PostgreSQL): Persists users, categories, transactions; schema managed by Alembic migrations.
|
||||||
|
- Message Queue (RabbitMQ): Transports background jobs from the API to the worker.
|
||||||
|
- Cache/Result Store (Redis): Available for caching or Celery result backend.
|
||||||
|
- Infrastructure as Code (tofu/): OpenTofu modules provisioning cluster services (RabbitMQ, Redis, Argo CD, cert-manager, Cloudflare tunnel, etc.).
|
||||||
|
- Deployment Chart (charts/myapp-chart/): Helm chart to deploy the application to Kubernetes.
|
||||||
|
|
||||||
### Technologies Used
|
### Technologies Used
|
||||||
|
|
||||||
- **Backend**: [e.g., Go, Node.js, Python]
|
- Backend: Python, FastAPI, FastAPI Users, SQLAlchemy, Pydantic, Alembic, Celery
|
||||||
- **Database**: [e.g., PostgreSQL, MongoDB, Redis]
|
- Frontend: React, TypeScript, Vite
|
||||||
- **Cloud Services**: [e.g., AWS EC2, Google Cloud Run, Azure Functions]
|
- Database: PostgreSQL
|
||||||
- **Container Orchestration**: [e.g., Docker, Kubernetes]
|
- Messaging: RabbitMQ
|
||||||
- **Other**: [List other significant technologies]
|
- Cache: Redis
|
||||||
|
- Containerization/Orchestration: Docker, Docker Compose (dev), Kubernetes, Helm
|
||||||
|
- IaC/Platform: OpenTofu (Terraform), Argo CD, cert-manager, MetalLB, Cloudflare Tunnel, Prometheus
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
### System Requirements
|
### System Requirements
|
||||||
|
|
||||||
- Operating System: [e.g., Linux, macOS, Windows]
|
- Operating System: Linux, macOS, or Windows
|
||||||
- Minimum RAM: [e.g., 8GB]
|
- Minimum RAM: 4 GB (8 GB recommended for running backend, frontend, and database together)
|
||||||
- Storage: [e.g., 10GB free space]
|
- Storage: 2 GB free (Docker images may require additional space)
|
||||||
|
|
||||||
### Required Software
|
### Required Software
|
||||||
|
|
||||||
- [Software 1] (version X.X or higher)
|
- Docker Desktop or Docker Engine 24+
|
||||||
- [Software 2] (version X.X or higher)
|
- Docker Compose v2+
|
||||||
- [etc.]
|
- Node.js 20+ and npm 10+ (for local frontend dev/build)
|
||||||
|
- Python 3.12+ (for local backend dev outside Docker)
|
||||||
|
- PostgreSQL 15+ (optional if running DB outside Docker)
|
||||||
|
- Helm 3.12+ and kubectl 1.29+ (for Kubernetes deployment)
|
||||||
|
- OpenTofu 1.7+ (for infrastructure provisioning)
|
||||||
|
|
||||||
### Dependencies
|
### Environment Variables (common)
|
||||||
|
|
||||||
```bash
|
- Backend: SECRET, FRONTEND_URL, BACKEND_URL, DATABASE_URL, RABBITMQ_URL, REDIS_URL
|
||||||
# List key dependencies that need to be installed
|
- OAuth vars (Backend): MOJEID_CLIENT_ID/SECRET, BANKID_CLIENT_ID/SECRET (optional)
|
||||||
# For example:
|
- Frontend: VITE_BACKEND_URL
|
||||||
# Docker Engine 20.10+
|
|
||||||
# Node.js 18+
|
### Dependencies (key libraries)
|
||||||
# Go 1.25+
|
I am not sure what is meant by "key libraries"
|
||||||
```
|
|
||||||
|
Backend: FastAPI, fastapi-users, SQLAlchemy, pydantic v2, Alembic, Celery
|
||||||
|
Frontend: React, TypeScript, Vite
|
||||||
|
Services: PostgreSQL, RabbitMQ, Redis
|
||||||
|
|
||||||
## Build Instructions
|
## Build Instructions
|
||||||
|
|
||||||
### 1. Clone the Repository
|
You can run the project with Docker Compose (recommended for local development) or run services manually.
|
||||||
|
|
||||||
|
### 1) Clone the Repository
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone [your-repository-url]
|
git clone https://github.com/dat515-2025/Group-8.git
|
||||||
cd [repository-name]
|
cd 7project
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Install Dependencies
|
### 2) Install dependencies
|
||||||
|
Backend
|
||||||
```bash
|
```bash
|
||||||
# Provide step-by-step commands
|
# In 7project/backend
|
||||||
# For example:
|
python3.12 -m venv .venv
|
||||||
# npm install
|
source .venv/bin/activate # Windows: .venv\Scripts\activate
|
||||||
# go mod download
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
Frontend
|
||||||
### 3. Build the Application
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Provide exact build commands
|
# In 7project/frontend
|
||||||
# For example:
|
npm install
|
||||||
# make build
|
|
||||||
# docker build -t myapp .
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4. Configuration
|
### 3) Manual Local Run
|
||||||
|
|
||||||
|
Backend
|
||||||
```bash
|
```bash
|
||||||
# Any configuration steps needed
|
# From the 7project/ directory
|
||||||
# Environment variables to set
|
docker compose up --build
|
||||||
# Configuration files to create
|
# This starts: PostgreSQL, RabbitMQ/Redis (if defined)
|
||||||
|
|
||||||
|
# Set environment variables (or create .env file)
|
||||||
|
export SECRET=CHANGE_ME_SECRET
|
||||||
|
export BACKEND_URL=http://127.0.0.1:8000
|
||||||
|
export FRONTEND_URL=http://localhost:5173
|
||||||
|
export DATABASE_URL=postgresql+asyncpg://user:password@127.0.0.1:5432/app
|
||||||
|
export RABBITMQ_URL=amqp://guest:guest@127.0.0.1:5672/
|
||||||
|
export REDIS_URL=redis://127.0.0.1:6379/0
|
||||||
|
|
||||||
|
# Apply DB migrations (Alembic)
|
||||||
|
# From 7project/backend
|
||||||
|
alembic upgrade head
|
||||||
|
|
||||||
|
# Run API
|
||||||
|
uvicorn app.app:fastApi --reload --host 0.0.0.0 --port 8000
|
||||||
|
|
||||||
|
# Run Celery worker (optional, for emails/background tasks)
|
||||||
|
celery -A app.celery_app.celery_app worker -l info
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Frontend
|
||||||
|
```bash
|
||||||
|
# Configure backend URL for dev
|
||||||
|
echo 'VITE_BACKEND_URL=http://127.0.0.1:8000' > .env
|
||||||
|
npm run dev
|
||||||
|
# Open http://localhost:5173
|
||||||
|
```
|
||||||
|
|
||||||
|
- Backend default: http://127.0.0.1:8000 (OpenAPI at /docs)
|
||||||
|
- Frontend default: http://localhost:5173
|
||||||
|
|
||||||
|
If needed, adjust compose services/ports in compose.yml.
|
||||||
|
|
||||||
|
|
||||||
## Deployment Instructions
|
## Deployment Instructions
|
||||||
|
|
||||||
### Local Deployment
|
### Local (Docker Compose)
|
||||||
|
|
||||||
|
Described in the previous section (Manual Local Run)
|
||||||
|
|
||||||
|
### Kubernetes (via OpenTofu + Helm)
|
||||||
|
|
||||||
|
1) Provision platform services (RabbitMQ/Redis/ingress/tunnel/etc.) with OpenTofu
|
||||||
```bash
|
```bash
|
||||||
# Step-by-step commands for local deployment
|
cd tofu
|
||||||
# For example:
|
# copy and edit variables
|
||||||
# docker-compose up -d
|
cp terraform.tfvars.example terraform.tfvars
|
||||||
# kubectl apply -f manifests/
|
# authenticate to your cluster/cloud as needed, then:
|
||||||
|
tofu init
|
||||||
|
tofu plan
|
||||||
|
tofu apply
|
||||||
```
|
```
|
||||||
|
|
||||||
### Cloud Deployment
|
2) Deploy the app using Helm
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Commands for cloud deployment
|
# Set the namespace
|
||||||
# Include any cloud-specific setup
|
kubectl create namespace myapp || true
|
||||||
|
|
||||||
|
# Install/upgrade the chart with required values
|
||||||
|
helm upgrade --install myapp charts/myapp-chart \
|
||||||
|
-n myapp \
|
||||||
|
-f charts/myapp-chart/values.yaml \
|
||||||
|
--set image.backend.repository=myorg/myapp-backend \
|
||||||
|
--set image.backend.tag=latest \
|
||||||
|
--set env.BACKEND_URL="https://myapp.example.com" \
|
||||||
|
--set env.FRONTEND_URL="https://myapp.example.com" \
|
||||||
|
--set env.SECRET="CHANGE_ME_SECRET"
|
||||||
|
```
|
||||||
|
Adjust values to your registry and domain. The chart’s NOTES.txt includes additional examples.
|
||||||
|
|
||||||
|
3) Expose and access
|
||||||
|
- If using Cloudflare Tunnel or an ingress, configure DNS accordingly (see tofu/modules/cloudflare and deployment/tunnel.yaml).
|
||||||
|
- For quick testing without ingress:
|
||||||
|
```bash
|
||||||
|
kubectl -n myapp port-forward deploy/myapp-backend 8000:8000
|
||||||
|
kubectl -n myapp port-forward deploy/myapp-frontend 5173:80
|
||||||
```
|
```
|
||||||
|
|
||||||
### Verification
|
### Verification
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Commands to verify deployment worked
|
# Check pods
|
||||||
# How to check if services are running
|
kubectl -n myapp get pods
|
||||||
# Example health check endpoints
|
|
||||||
|
# Backend health
|
||||||
|
curl -i http://127.0.0.1:8000/
|
||||||
|
# OpenAPI
|
||||||
|
open http://127.0.0.1:8000/docs
|
||||||
|
|
||||||
|
# Frontend (if port-forwarded)
|
||||||
|
open http://localhost:5173
|
||||||
```
|
```
|
||||||
|
|
||||||
## Testing Instructions
|
## Testing Instructions
|
||||||
@@ -156,19 +241,38 @@ cd [repository-name]
|
|||||||
|
|
||||||
## Usage Examples
|
## Usage Examples
|
||||||
|
|
||||||
### Basic Usage
|
All endpoints are documented at OpenAPI: http://127.0.0.1:8000/docs
|
||||||
|
|
||||||
|
### Auth: Register and Login (JWT)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Examples of how to use the application
|
# Register
|
||||||
# Common commands or API calls
|
curl -X POST http://127.0.0.1:8000/auth/register \
|
||||||
# Sample data or test scenarios
|
-H 'Content-Type: application/json' \
|
||||||
|
-d '{
|
||||||
|
"email": "user@example.com",
|
||||||
|
"password": "StrongPassw0rd",
|
||||||
|
"first_name": "Jane",
|
||||||
|
"last_name": "Doe"
|
||||||
|
}'
|
||||||
|
|
||||||
|
# Login (JWT)
|
||||||
|
TOKEN=$(curl -s -X POST http://127.0.0.1:8000/auth/jwt/login \
|
||||||
|
-H 'Content-Type: application/x-www-form-urlencoded' \
|
||||||
|
-d 'username=user@example.com&password=StrongPassw0rd' | jq -r .access_token)
|
||||||
|
|
||||||
|
echo $TOKEN
|
||||||
|
|
||||||
|
# Call a protected route
|
||||||
|
curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
||||||
```
|
```
|
||||||
|
|
||||||
### Advanced Features
|
### Frontend
|
||||||
|
|
||||||
```bash
|
- Start with: npm run dev in 7project/frontend
|
||||||
# Examples showcasing advanced functionality
|
- Ensure VITE_BACKEND_URL is set to the backend URL (e.g., http://127.0.0.1:8000)
|
||||||
```
|
- Open http://localhost:5173
|
||||||
|
- Login, view latest transactions, filter, and add new transactions from the UI.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -215,18 +319,18 @@ cd [repository-name]
|
|||||||
> This information is used for individual grading.
|
> This information is used for individual grading.
|
||||||
> Link to the specific commit on GitHub for each contribution.
|
> Link to the specific commit on GitHub for each contribution.
|
||||||
|
|
||||||
| Task/Component | Assigned To | Status | Time Spent | Difficulty | Notes |
|
| Task/Component | Assigned To | Status | Time Spent | Difficulty | Notes |
|
||||||
| ------------------------------------------------------------------- | ----------- | ------------- | ---------- | ---------- | ----------- |
|
|-----------------------------------------------------------------------|-------------| ------------- |----------------|------------| ----------- |
|
||||||
| Project Setup & Repository | [Name] | ✅ Complete | [X hours] | Medium | [Any notes] |
|
| [Project Setup & Repository](https://github.com/dat515-2025/Group-8#) | Lukas | ✅ Complete | [X hours] | Medium | [Any notes] |
|
||||||
| [Design Document](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Easy | [Any notes] |
|
| [Design Document](https://github.com/dat515-2025/Group-8/blob/main/6design/design.md) | Both | ✅ Complete | 2 Hours | Easy | [Any notes] |
|
||||||
| [Backend API Development](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Hard | [Any notes] |
|
| [Backend API Development](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/api) | Dejan | ✅ Complete | 10 hours | Medium | [Any notes] |
|
||||||
| [Database Setup & Models](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Medium | [Any notes] |
|
| [Database Setup & Models](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/models) | Lukas | ✅ Complete | [X hours] | Medium | [Any notes] |
|
||||||
| [Frontend Development](https://github.com/dat515-2025/group-name) | [Name] | 🔄 In Progress | [X hours] | Medium | [Any notes] |
|
| [Frontend Development](https://github.com/dat515-2025/Group-8/tree/main/7project/frontend) | Dejan | 🔄 In Progress | 7 hours so far | Medium | [Any notes] |
|
||||||
| [Docker Configuration](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Easy | [Any notes] |
|
| [Docker Configuration](https://github.com/dat515-2025/Group-8/blob/main/7project/compose.yml) | Lukas | ✅ Complete | [X hours] | Easy | [Any notes] |
|
||||||
| [Cloud Deployment](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Hard | [Any notes] |
|
| [Cloud Deployment](https://github.com/dat515-2025/Group-8/blob/main/7project/deployment/app-demo-deployment.yaml) | Lukas | ✅ Complete | [X hours] | Hard | [Any notes] |
|
||||||
| [Testing Implementation](https://github.com/dat515-2025/group-name) | [Name] | ⏳ Pending | [X hours] | Medium | [Any notes] |
|
| [Testing Implementation](https://github.com/dat515-2025/group-name) | Dejan | ❌ Not Started | [X hours] | Medium | [Any notes] |
|
||||||
| [Documentation](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Easy | [Any notes] |
|
| [Documentation](https://github.com/dat515-2025/group-name) | Both | ❌ Not Started | [X hours] | Easy | [Any notes] |
|
||||||
| [Presentation Video](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Medium | [Any notes] |
|
| [Presentation Video](https://github.com/dat515-2025/group-name) | Both | ❌ Not Started | [X hours] | Medium | [Any notes] |
|
||||||
|
|
||||||
**Legend**: ✅ Complete | 🔄 In Progress | ⏳ Pending | ❌ Not Started
|
**Legend**: ✅ Complete | 🔄 In Progress | ⏳ Pending | ❌ Not Started
|
||||||
|
|
||||||
@@ -244,25 +348,16 @@ cd [repository-name]
|
|||||||
| [Date] | Documentation | [X.X] | Updated README and design doc |
|
| [Date] | Documentation | [X.X] | Updated README and design doc |
|
||||||
| **Total** | | **[XX.X]** | |
|
| **Total** | | **[XX.X]** | |
|
||||||
|
|
||||||
### [Team Member 2 Name]
|
### Dejan
|
||||||
|
|
||||||
| Date | Activity | Hours | Description |
|
| Date | Activity | Hours | Description |
|
||||||
| --------- | -------------------- | ---------- | ----------------------------------------- |
|
|-------------|----------------------|--------|--------------------------------|
|
||||||
| [Date] | Frontend Development | [X.X] | Created user interface mockups |
|
| 25.9. | Design | 1.5 | 6design |
|
||||||
| [Date] | Integration | [X.X] | Connected frontend to backend API |
|
| 9-11.10. | Backend APIs | 10 | Implemented Backend APIs |
|
||||||
| [Date] | Deployment | [X.X] | Docker configuration and cloud deployment |
|
| 13-15.10. | Frontend Development | 6.5 | Created user interface mockups |
|
||||||
| [Date] | Testing | [X.X] | End-to-end testing |
|
| Continually | Documantation | 3 | Documenting the dev process |
|
||||||
| **Total** | | **[XX.X]** | |
|
| **Total** | | **21** | |
|
||||||
|
|
||||||
### [Team Member 3 Name] (if applicable)
|
|
||||||
|
|
||||||
| Date | Activity | Hours | Description |
|
|
||||||
| --------- | ------------------------ | ---------- | -------------------------------- |
|
|
||||||
| [Date] | Database Design | [X.X] | Schema design and implementation |
|
|
||||||
| [Date] | Cloud Configuration | [X.X] | AWS/GCP setup and configuration |
|
|
||||||
| [Date] | Performance Optimization | [X.X] | Caching and query optimization |
|
|
||||||
| [Date] | Monitoring | [X.X] | Logging and monitoring setup |
|
|
||||||
| **Total** | | **[XX.X]** | |
|
|
||||||
|
|
||||||
### Group Total: [XXX.X] hours
|
### Group Total: [XXX.X] hours
|
||||||
|
|
||||||
@@ -292,11 +387,8 @@ cd [repository-name]
|
|||||||
|
|
||||||
[Personal reflection on growth, challenges, and learning]
|
[Personal reflection on growth, challenges, and learning]
|
||||||
|
|
||||||
#### [Team Member 3 Name] (if applicable)
|
|
||||||
|
|
||||||
[Personal reflection on growth, challenges, and learning]
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Report Completion Date**: [Date]
|
**Report Completion Date**: [Date]
|
||||||
**Last Updated**: [Date]
|
**Last Updated**: 15.10.2025
|
||||||
Reference in New Issue
Block a user