Skip to content

DJWOMS/useful

Repository files navigation

Useful

Описание проекта:

Когда человек приходить в профессию программиста, что бы научиться писать программы нужно много практики и верная структура и последовательность в обучении, и командная разработка. Чтобы научиться программировать не опытных специалистов отправляют найти проект на GitHub или написать свой проект. Но найти подходящий проект на GitHub молодому специалисту невероятно тяжело, так как не реализован нужный поиск.

Проект UseFul призван помочь таким людям.

Инструменты разработки

Стек:

  • Python >= 3.8
  • FastAPI >= 0.61
  • Tortoise ORM
  • Postgres

Ссылки:

Старт

1) Создать образ

docker-compose build
2) Запустить контейнер
docker-compose up
3) Перейти по адресу
http://127.0.0.1:8000/docs

Разработка с Docker

1) Сделать форк репозитория
2) Клонировать репозиторий
git clone ссылка_сгенерированная_в_вашем_репозитории
3) В корне проекта создать .env.dev
SECRET_KEY=fuf823rg2388gc828^&%&^%^&T^&gf
SERVER_HOST=127.0.0.1

# Data Base
POSTGRES_DB=useful_dev
POSTGRES_USER=useful_user
POSTGRES_PASSWORD=useful_pass
POSTGRES_HOST=useful-db

# Email
SMTP_TLS=True
SMTP_PORT=587
SMTP_HOST=smtp
SMTP_USER=robot@your.com
SMTP_PASSWORD=pass
EMAILS_FROM_EMAIL=robot@your.com
4) В папке src.config файл social_app.py-exp переименовать в social_app.py
прописать свои данные от app GitHub
5) Создать образ
docker-compose build
6) Запустить контейнер
docker-compose up
7) Создать миграции
docker exec -it useful-back aerich init-db
8) Создать суперюзера
docker exec -it useful-back python scripts/createsuperuser.py
9) Если не выполняет команды
  • Войти в контейнер - docker exec -it useful-back bash
  • Выполнить команды без docker exec -it useful-back
10) Если нужно очистить БД
docker-compose down -v
11) Создать миграции
docker exec -it useful-back aerich migrate
12) Выполнить миграции
docker exec -it useful-back aerich upgrade

License

BSD 3-Clause License

Copyright (c) 2020-present, DJWOMS - Omelchenko Michael