Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dmitry-sidorov committed Jan 22, 2025
1 parent 6951cff commit 4e49a88
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions docs/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,62 @@
3. Database: Postgres
4. Mobile: Adaptive LiveView (ReactNative?, Flutter?)
5. Bot: Telegram

### API Requirements

#### Authentication

- User registration and login endpoints
- JWT token-based authentication
- Password reset functionality

#### User Management

- CRUD operations for user profiles
- User preferences and settings
- User groups management for shared budgets

#### Accounts

- Create/update/delete financial accounts
- Support multiple currencies
- Track account balances
- Transfer between accounts

#### Transactions

- Record income and expenses
- Bulk transaction import
- Recurring transactions
- Transaction categories management
- Transaction tags
- Attach receipts/documents to transactions

#### Budget Planning

- Create budget plans for different periods
- Set spending limits by category
- Track actual vs planned spending
- Budget templates
- Budget sharing within groups

#### Reports & Analytics

- Spending trends by category
- Income vs expense analysis
- Monthly/yearly reports
- Custom date range reports
- Export data in various formats (CSV, PDF)

#### Notifications

- Budget limit alerts
- Bill payment reminders
- Unusual spending patterns
- Group activity notifications

#### Currency

- Real-time currency conversion
- Support for multiple currencies
- Historical exchange rates

0 comments on commit 4e49a88

Please sign in to comment.