LifeManager - Фінансовий помічник

Сучасний веб-додаток для управління особистими фінансами та плануванням подій

Особливості

• Управління транзакціями: Відстеження доходів та витрат з категоризацією
• Аналітика: Статистика витрат по категоріях та періодах
• Планування подій: Календар завдань з пріоритетами та дедлайнами
• Профілі користувачів: Персоналізація з аватарками
• Безпечна авторизація: Власна реєстрація + Google/GitHub OAuth
• REST API: Повноцінний API з Swagger документацією
• Сучасний UI: Адаптивний дизайн з Bootstrap 5

Технологічний стек

• Backend: Django 5.2+ | Django REST Framework 3.15+
• Frontend: HTML5 | CSS3 | JavaScript | Bootstrap 5
• База даних: SQLite (розробка) | PostgreSQL (продакшн)
• Авторизація: django-allauth (Google, GitHub OAuth)
• API: drf-spectacular (OpenAPI/Swagger)
• Тестування: pytest | coverage.py
• CI/CD: GitHub Actions

Встановлення та запуск

1️⃣ Клонування репозиторію

git clone https://github.com/SMatvii/LifeManager.git

2️⃣ Створення віртуального середовища

Windows:

# Створення віртуального середовища
python -m venv venv

# Активація
venv\Scripts\activate

Linux/Mac:

# Створення віртуального середовища
python3 -m venv venv

# Активація
source venv/bin/activate

3️⃣ Встановлення залежностей

# Оновлення pip до останньої версії
python -m pip install --upgrade pip

# Встановлення всіх залежностей з requirements.txt
pip install -r requirements.txt

4️⃣ Налаштування середовища

# Перехід до директорії Django проекту
cd finassistant

# Копіювання файлу налаштувань (або створення власного)
copy .env.example .env    # Windows
# або
cp .env.example .env      # Linux/Mac

Відредагуйте файл .env:

Створіть файл `.env` в корені проекту та додайте наступні змінні:
```env
SECRET_KEY=""
DEBUG="True"
DATABASE_URL="sqlite:///db.sqlite3"
DATABASE_NAME="db.sqlite3"

GOOGLE_CLIENT_ID = ""
GOOGLE_CLIENT_SECRET = ""

GITHUB_CLIENT_ID = ""
GITHUB_CLIENT_SECRET = ""

секретний ключ можна згенерувати за допомогою Django:

python -c "from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())"

Нижче покроково описано, як отримати ці значення.

🔐 Як отримати Google OAuth 2.0 Client ID та Secret

1. Перейдіть на Google Cloud Console.
2. Створіть новий проєкт або виберіть існуючий.
3. У меню зліва оберіть APIs & Services > Credentials.
4. Натисніть Create Credentials > OAuth 2.0 Client ID.
5. Якщо потрібно, спочатку налаштуйте OAuth consent screen:
   • Оберіть тип (Internal або External)
   • Заповніть необхідну інформацію: App name, User support email, Developer contact info.
6. Оберіть Application type: Web application.
7. Додайте авторизовані URI:
   • Authorized redirect URIs, в нашому випадку це: http://127.0.0.1:8000/accounts/google/login/callback/
8. Після створення ви отримаєте:
   • Client ID
   • Client Secret

Збережіть ці значення у .env файлі вашого проєкту.

---

🔐 Як отримати GitHub OAuth Client ID та Secret

1. Перейдіть на GitHub Developer Settings.
2. Оберіть OAuth Apps → натисніть New OAuth App.
3. Заповніть форму:
   • Application name: назва вашого додатку
   • Homepage URL: в нашому випадку це, http://127.0.0.1:8000/
   • Authorization callback URL: в нашому випадку це, http://127.0.0.1:8000/accounts/github/login/callback/
4. Натисніть Register Application.
5. Ви отримаєте:
   • Client ID
   • Натисніть Generate a new client secret, щоб отримати Client Secret

Збережіть значення у .env файлі.

5️⃣ Міграції бази даних

# Створення міграцій для моделей
python manage.py makemigrations

# Застосування міграцій
python manage.py migrate

# Перевірка статусу міграцій
python manage.py showmigrations

# Опціонально: створення суперкористувача для адмінки
python manage.py createsuperuser

6️⃣ Запуск сервера розробки

python manage.py runserver

Тестування

Запуск тестів

# Всі тести
python manage.py test

# Тести з pytest
pytest

# Тести з покриттям коду
pytest --cov=core --cov-report=html --cov-report=term-missing

# Тести конкретного додатку
python manage.py test core

API Документація

Після запуску сервера доступні:

• Swagger UI: http://127.0.0.1:8000/api/schema/swagger-ui/
• ReDoc: http://127.0.0.1:8000/api/schema/redoc/
• JSON Schema: http://127.0.0.1:8000/api/schema/
• Django Admin: http://127.0.0.1:8000/admin/

Основні ендпоінти API

GET    /api/transactions/     - Список транзакцій
POST   /api/transactions/     - Створення транзакції
GET    /api/transactions/{id}/ - Деталі транзакції
PUT    /api/transactions/{id}/ - Оновлення транзакції
DELETE /api/transactions/{id}/ - Видалення транзакції

GET    /api/categories/       - Список категорій
POST   /api/categories/       - Створення категорії

GET    /api/events/           - Список подій
POST   /api/events/           - Створення події

GET    /api/profile/          - Профіль користувача

Основні команди Django

# Створення нового додатку
python manage.py startapp myapp

# Створення міграцій після змін в моделях
python manage.py makemigrations

# Застосування міграцій
python manage.py migrate

# Створення суперкористувача
python manage.py createsuperuser

# Запуск інтерактивної оболонки Django
python manage.py shell

Внесок у проект

1. Fork репозиторію
2. Створіть feature branch: git checkout -b feature/AmazingFeature
3. Commit ваші зміні: git commit -m 'Add some AmazingFeature'
4. Push в branch: git push origin feature/AmazingFeature
5. Відкрийте Pull Request

Цей проект ліцензовано під MIT License - див. файл LICENSE для деталей.