personal-training-and-nutrition-backend

Описание

Технологии

• Python 3.11.5
• Django 4.2.4
• Django REST framework 3.12.4
• Djoser 2.2.0
• SQLite3

Установка

1. Клонировать репозиторий (открываешь терминал в нужной папке и вставляешь эту строчку, и нажимаешь "ENTER", в директории появится папка с названием проекта):

   git clone git@github.com:Personal-training-and-nutrition/personal-training-and-nutrition-backend.git

2. Переходишь в ветку develop:

   cd personal-training-and-nutrition-backend && git checkout develop

3. Установить виртуальное окружение для проекта (там же набираешь одну из этих команд и нажимаешь "ENTER", в директории появится папка env):

   # для OS Lunix и MacOS
   python3 -m venv venv
   
   # для OS Windows и MacOS
   python -m venv venv

4. Активировать виртуальное окружение для проекта (там же набираешь одну из этих команд и нажимаешь "ENTER", в терминал слева появится (venv) - значит ты в виртуально окружении)):

   # для OS Lunix и MacOS
   source venv/bin/activate
   
   # для OS Windows
   source venv/Scripts/activate

5. Установить зависимости (так же в той же директории):

   # для OS Lunix и MacOS
   python3 -m pip install --upgrade pip && pip install -r requirements.txt
   
   # для OS Windows
   python -m pip install --upgrade pip && pip install -r requirements.txt

6. Cоздайте файл .env в директории /backend/:

   cd backend && nano .env
   
   В открывшийся редактор вставьте ключи ниже и после закройте командой "Ctrl + X"
   
   SECRET_KEY=любой_секретный_ключ_на_ваш_выбор
   DEBUG=''
   ALLOWED_HOSTS='*' (или,ваши,хосты,через,запятые,без,пробелов)
   DEVELOPMENT=True (если хотите работать на sqlite, иначе - False)
   
   POSTGRES_USER=
   POSTGRES_PASSWORD=
   POSTGRES_DB=
   DB_HOST=
   DB_PORT=
   
   SOCIAL_AUTH_MAILRU_KEY=
   SOCIAL_AUTH_MAILRU_SECRET=
   SOCIAL_AUTH_VK_OAUTH2_KEY=
   SOCIAL_AUTH_VK_OAUTH2_SECRET=
   SOCIAL_AUTH_YANDEX_KEY=
   SOCIAL_AUTH_YANDEX_SECRET=
   
   EMAIL_HOST_USER=
   EMAIL_HOST_PASSWORD=

7. Выполнить миграции на уровне проекта из директории /backend/ (если не вы перешли на нее предыдущей комнадно cd backend, то выполните команду cd backend):

   # для OS Lunix и MacOS
   python3 manage.py makemigrations && python3 manage.py migrate
   
   # для OS Windows
   python manage.py makemigrations && python manage.py migrate

8. Запускаешь проект локально:

   # для OS Lunix и MacOS
   python3 manage.py runserver
   
   # для OS Windows
   python manage.py runserver

Работа с документацией и Postman после запуска проекта

1. Открываешь документацию по одной из ссылок:

   • Swagger UI
   • ReDoc (более аутентичный и простой интерфейс)

2. Чтобы импортировать коллекцию в Postman и использовать ее для тестирования:

   • Откройте Postman и нажмите на кнопку "Import" в верхнем левом углу.
   • В разделе "Link" вставьте ссылку http://127.0.0.1:8000/api/schema/ и нажмите на кнопку "Continue".
   • В появившемся окне у вас будет возможность выбрать каталог, в который нужно импортировать.

3. Если не понимаешь, то смотришь видео по ссылкам:

   • Запись вебинара от ментора СА по OpenApi и Postman
   • Видео по работе с Postman от Никиты

Вход в админку

1. ввести команду 'python manage.py createsuperuser', там придумаешь почту и пароль

   # для OS Lunix и MacOS
   python3 manage.py createsuperuser
   
   # для OS Windows
   python manage.py createsuperuser

2. Запускаешь проект локально:

   # для OS Lunix и MacOS
   python3 manage.py runserver
   
   # для OS Windows
   python manage.py runserver

3. Заходишь по адресу http://127.0.0.1:8000/admin со своим почтой и паролем