backend for volunteers for city projects
REST API для Проекта Платформа для волонтеров
http://better-together.acceleratorpracticum.ru/
Админ панель доступна по ссылке http://better-together.acceleratorpracticum.ru/admin/
(в процессе разработки, может надо api)
Документация доступна по ссылке http://better-together.acceleratorpracticum.ru/swagger/
Стек технологий:
Как запустить проект локально (необходим установленный Python3.10.6):
Клонировать репозиторий и перейти в него в командной строке:
git clone git@github.com:volunteers-for-city-projects/volunteers-backend.gitcd volunteers-backend/Cоздать виртуальное окружение:
python3 -m venv venvАктивировать созданное виртуальное окружение:
-
для Linux
source venv/bin/activate -
для Windows
venv\Scripts\activate.bat
Установить зависимости из файла requirements.txt:
python3 -m pip install --upgrade pippip install -r ./backend/requirements.txtПеремещаемся в директорию backend для дальнейшей работы:
cd backend/Выполнить миграции:
для корректной работы следующих команд необходим файл .env в директории infra_bt, созданный по шаблону файла .env.example в той же директории и подготовлена БД postgresql с соответствующими настройками.
python3 manage.py migrateСоздание суперпользователя (если необходим доступ в админку Django):
При создании будет затребовано ввести "Роль:" - вводим admin:
python3 manage.py createsuperuserЗапустить проект:
python3 manage.py runserverДокументация для Проекта станет доступна по адресу:
http://localhost:8000/swagger/
Админка станет доступна по адресу:
Как запустить проект локально в Docker контейнерах (необходим установленный docker + docker-compose или Docker Desktop):
Клонировать репозиторий и перейти в директорию infra_bt проекта:
git clone git@github.com:volunteers-for-city-projects/volunteers-backend.gitcd volunteers-backend/infra_bt/Подготовить .env файл по шаблону файла .env.example
Запустить сборку Docker контейнеров проекта:
docker compose up -dДокументация для Проекта станет доступна по адресу:
http://localhost:8000/swagger/