update readme.md

This commit is contained in:
Александр Манаенков 2023-04-06 19:40:34 +10:00
parent 7d89b5b74e
commit e4f1f973ef
1 changed files with 22 additions and 8 deletions

View File

@ -1,8 +1,11 @@
# Аренда квартир для студентов
В проекте есть три ветки:
- main — в эту ветку загружается код после положительного тестирования и ревью.
- dev_stable — в эту ветку загружается стабильный код, который будет использоваться в продашкене.
- dev_unstable — основная ветка для разработчиков.
## ТУТ НАЗВАНЫ ПАПКИ ПОД РАЗРАБОТКУ И ФРОНТ В БЕК НЕ ЗАХОДИТ И НИЧЕГО НЕ МЕНЯЕТ!
## Как начать работать?
@ -17,46 +20,57 @@
Команды написаны под windows. Вводить в командную строку. Проверяйте, что в терминале вы находитесь в правильной директории
- Клонируем репозиторий
```bash
git clone https://github.com/vvsu-rent-project/dev_rent.github
```
- В консоли переходим в папку проекта
- Далее переходим на ветку unstable
```bash
git switch dev_unstable
```
### Клонирование проекта через GitHub Desktop
- Заходим в настройки
![Заходим в настройки](README_img/1_step.png)
![Заходим в настройки](misc/1_step.png)
- Входим в аккаунт
![Входим в аккаунт](README_img/2_step.png)
![Входим в аккаунт](misc/2_step.png)
- Клонируем репозиторий
![Клонируем репозиторий](README_img/3_step.png)
![Клонируем репозиторий](misc/3_step.png)
![Клонируем репозиторий](README_img/4_step.png)
![Клонируем репозиторий](misc/4_step.png)
### Подготовка проекта к работе
- Открываем VS Code, открываем папку проекта и запускаем терминал
- В терминале переходим в папку pairent_backend
```bash
cd pairent_backend
```
- Создаем виртуальное окружение
```bash
python -m venv venv
```
- Активируем виртуальное окружение. Активировать окружение нужно: когда запускаете сервер, устанавливаете зависимости, добавляете новое django приложение
```bash
venv\Scripts\activate
```
- После активации, устанавливаем зависимости.
```bash
pip install -r requirements.txt
```