Skip to content

feat: Update README #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miko44quliyev merged 1 commit into from
May 14, 2026
+54 −30
Merged

feat: Update README #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 52 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,53 +59,72 @@ Clean layered architecture:

## 🗄️ Database Design

### 👤 Account
| Field | Type | Notes |
|-----------------|---------------|------------------------------|
| id | Long | PK, auto-increment |
| full_name | varchar(255) | |
| email | varchar(255) | Not null, valid email format |
| current_balance | decimal(10,2) | |
| created_at | timestamp | Set on persist |

### 📂 Category
| Field | Type | Notes |
|-------------|---------------|-------------------|
| id | bigint | PK, auto-increment|
| name | varchar(100) | Not null, unique |
| description | varchar(255) | |
| created_at | timestamp | |
| updated_at | timestamp | |
| Field | Type | Notes |
|-------------|---------------|--------------------|
| id | Long | PK, auto-increment |
| name | varchar(100) | Not null, unique |
| description | varchar(255) | |
| created_at | timestamp | |
| updated_at | timestamp | |

### 📊 Budget
| Field | Type | Notes |
|--------------|----------------|--------------------------------|
| id | bigint | PK, auto-increment |
| category_id | bigint | FK → categories.id |
| month | date | First day of month (2026-01-01)|
| limit_amount | decimal(10,2) | Not null |
| created_at | timestamp | |
| updated_at | timestamp | |
| Field | Type | Notes |
|--------------|---------------|---------------------------------|
| id | Long | PK, auto-increment |
| category_id | Long | FK → categories.id |
| month | date | First day of month (2026-01-01) |
| limit_amount | decimal(10,2) | Not null |
| created_at | timestamp | |
| updated_at | timestamp | |

> Unique constraint on `(category_id, month)` — one budget per category per month.

### 💰 Expense
| Field | Type | Notes |
|----------------|----------------|--------------------|
| id | bigint | PK, auto-increment |
| title | varchar(100) | Not null |
| amount | decimal(10,2) | Not null |
| expense_date | date | Not null |
| payment_method | varchar(20) | cash, credit_card… |
| notes | text | |
| is_recurring | boolean | Default false |
| category_id | bigint | FK → categories.id |
| created_at | timestamp | |
| updated_at | timestamp | |
| Field | Type | Notes |
|----------------|---------------|------------------------|
| id | Long | PK, auto-increment |
| title | varchar(255) | |
| amount | decimal(10,2) | |
| expense_date | date | |
| payment_method | varchar(50) | Enum: PaymentMethod |
| account_id | Long | FK → accounts.id |
| category_id | Long | FK → categories.id |
| budget_id | Long | FK → budgets.id |
| created_at | timestamp | Set on persist |

---

## 🔗 Relationships

- `Account` → `Expense` (One-to-Many) — each expense belongs to one account
- `Category` → `Budget` (One-to-Many) — each category can have a budget per month
- `Category` → `Expense` (One-to-Many) — each expense belongs to one category
- Budget for an expense is resolved by matching `category_id` + `month` from `expense_date`
- `Budget` → `Expense` (One-to-Many) — each expense is linked directly to a budget

---

## 📌 API Endpoints

### 👤 Account

| Method | Endpoint | Description |
|--------|------------------------|---------------------|
| POST | `/api/accounts` | Create account |
| GET | `/api/accounts` | List all accounts |
| GET | `/api/accounts/{id}` | Get account by ID |
| PUT | `/api/accounts/{id}` | Update account |
| DELETE | `/api/accounts/{id}` | Delete account |

### 📂 Category

| Method | Endpoint | Description |
Expand Down Expand Up @@ -263,6 +282,8 @@ Workflow steps:

Deployed using **Render** with a managed **PostgreSQL** database.

🌐 **Live URL:** [https://expensetrackerapi-1-aeen.onrender.com](https://expensetrackerapi-1-aeen.onrender.com)

Required environment variables on Render:

| Variable | Value |
Expand All @@ -284,7 +305,8 @@ Required environment variables on Render:

## 📊 Key Features

- Full CRUD for expenses, categories, and budgets
- Full CRUD for expenses, categories, budgets, and accounts
- Account management with balance tracking
- Category-based expense grouping
- Monthly budget per category with limit tracking
- Payment method tracking
Expand Down Expand Up @@ -325,4 +347,4 @@ This project is for educational purposes only.

---

> ⭐ Status: **Backend Complete · Docker Ready · CI/CD Active · Deployed on Render**
> ⭐ Status: **Backend Complete · Docker Ready · CI/CD Active · Deployed on Render**
2 changes: 2 additions & 0 deletions src/main/java/com/example/expencetrackerapi/repository/ExpenseRepository.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@

import com.example.expencetrackerapi.entity.Expense;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface ExpenseRepository extends JpaRepository<Expense, Long> {}
Loading