MVP CRM-системы для Амбассадоров Яндекс Практикума.

О проекте

Проект команды №10 в хакатоне Яндекс-Практикума.

Команда разработчиков

• Рагимов Шериф
• Зеленчук Михаил
• Земцов Антон
• Гуржий Вадим

Технологии

Начало работы

Эти инструкции позволят вам запустить копию проекта на вашем локальном компьютере для разработки и тестирования.

Запуск с использованием Docker

Предварительные требования

Убедитесь, что у вас установлены Docker и Docker Compose. Это можно сделать, следуя официальной документации Docker: https://docs.docker.com/get-docker/ и https://docs.docker.com/compose/install/

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

1. Клонируйте репозиторий на локальный компьютер:

   git clone git@github.com:Tenth-Team/backend.git
   cd backend/infra
   

2. Запустите контейнеры с помощью Docker Compose:

   docker compose -f docker-compose.local.yml up
   

   Теперь приложение должно быть доступно по адресу:

   http://localhost:8000

   А документация доступна по адресу:

   http://localhost:8000/api/v1/swagger/

Локальный запуск через pip

Предварительные требования

Убедитесь, что у вас установлен Python и pip. Рекомендуется использовать виртуальное окружение для изоляции зависимостей проекта.

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

1. Клонируйте репозиторий на локальный компьютер:

   git clone git@github.com:Tenth-Team/backend.git
   cd backend/backend
   

2. Создайте и активируйте виртуальное окружение:

   python -m venv venv
   source venv/bin/activate  # На Windows используйте `venv\Scripts\activate`
   

3. Установите зависимости:

   pip install -r requirements.txt
   

4. Запустите проект (пример для Django):

   python manage.py migrate
   python manage.py runserver
   

   Теперь приложение должно быть доступно по адресу:

   http://localhost:8000

   А документация доступна по адресу:

   http://localhost:8000/api/v1/swagger/

Ссылка на скриншот документации: