«CryptoTracker» - трекер криптопортфеля

Описание

• Проект CryptoTracker это удобный инструмент учета для хранения всех своих крипто-инвестиций в одном месте, пользователи могут проанализировать стоимость инвестиций, доходы и статистику по ним в виде графиков и диаграмм.

Установка и запуск

Проект разбит на 7 docker-контейнеров:

• backend — бэкенд проекта
• frontend — фронтенд проекта
• celery — асинхронные периодические задачи для бэкенда
• celery-beat — планировщик задач для celer
• flower — админка для Celery
• postgres — образ базы данных PostgreSQL
• nginx — web-сервер nginx

1. Склонировать репозиторий: git clone https://github.com/bitcoineazy/CryptoTracker.git
2. Установить: docker, docker-compose: sudo apt install docker && sudo apt install docker-compose
3. Создать .env файл в директории infrastructure со значениями:

DB_ENGINE=django.db.backends.postgresql
DB_NAME=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
DB_HOST=db
DB_PORT=5432

4. Перейти в директорию infrastructure cобрать проект и запустить: sudo docker-compose up --build -d
5. Собрать базу данных на основе ресурсов: sudo docker-compose exec backend python manage.py makemigrations && sudo docker-compose exec backend python manage.py migrate
6. Загрузить готовую бд: sudo docker-compose exec backend python3 manage.py loaddata assets_admin_db.json
7. Создать профиль администратора: sudo docker-compose exec backend python manage.py createsuperuser
8. Собрать статику: sudo docker-compose exec backend python manage.py collectstatic

Для сборки и использования своего контейнера backend:

1. В директории backend/TrackerBackend - sudo docker build -t username/container .
2. Запушить образ на свой dockerhub - sudo docker push username/container
3. Модифицировать поле backend image в infrastructure/docker-compose.yml на свой контейнер

Для загрузки данных и редактирования файлов контейнера

1. sudo docker exec -u 0 -it {id_контейнера из docker ps} /bin/sh

Доступ к сервису (локальный)

• Описание API-эндоинтов: 127.0.0.1:80/api/
• Django админка 127.0.0.1:80/admin/
• Flower админка для Celery 127.0.0.1:5566/

Документация и документы

1. Основная информация о проекте
2. ТЗ (техническое задание к проекту)
3. Описание автоматизируемых функций
4. Схема функциональной структуры автоматизируемой деятельности
5. Описание программного обеспечения АС
6. Схема логической структуры БД
7. Концепция ИС
8. Работа с требованиями заинтересованных лиц
9. Контейнеризация
10. Применение системы Git
11. UML заинтересованные лица
12. Архитектурные принципы
13. Unittest & pipeline
14. Паттерны проектирования
15. Рефакторинг кода проекта