Tochka
/
legacy
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,14 +1,17 @@
# Аренда квартир для студентов # Аренда квартир для студентов
В проекте есть три ветки: В проекте есть три ветки:
- main — в эту ветку загружается код после положительного тестирования и ревью. - main — в эту ветку загружается код после положительного тестирования и ревью.
- dev_stable — в эту ветку загружается стабильный код, который будет использоваться в продашкене. - dev_stable — в эту ветку загружается стабильный код, который будет использоваться в продашкене.
- dev_unstable — основная ветка для разработчиков. - dev_unstable — основная ветка для разработчиков.
## ТУТ НАЗВАНЫ ПАПКИ ПОД РАЗРАБОТКУ И ФРОНТ В БЕК НЕ ЗАХОДИТ И НИЧЕГО НЕ МЕНЯЕТ! ## ТУТ НАЗВАНЫ ПАПКИ ПОД РАЗРАБОТКУ И ФРОНТ В БЕК НЕ ЗАХОДИТ И НИЧЕГО НЕ МЕНЯЕТ!
## Как начать работать? ## Как начать работать?
- Устанавливаем [python](https://www.python.org/downloads/) версия 3.11.1 и [git](https://git-scm.com/) - Устанавливаем [python](https://www.python.org/downloads/) версия 3.11.1 и [git](https://git-scm.com/)
- [Настройте git](https://tproger.ru/curriculum/git-guide/). В основном нужно только ввести имя пользователя и почту, пароль запросит при клонировании - [Настройте git](https://tproger.ru/curriculum/git-guide/). В основном нужно только ввести имя пользователя и почту, пароль запросит при клонировании
Если не хотите заморачиваться с терминалом. Советую использовать [GitHub Desktop](https://desktop.github.com/) Если не хотите заморачиваться с терминалом. Советую использовать [GitHub Desktop](https://desktop.github.com/)
@ -17,46 +20,57 @@
Команды написаны под windows. Вводить в командную строку. Проверяйте, что в терминале вы находитесь в правильной директории Команды написаны под windows. Вводить в командную строку. Проверяйте, что в терминале вы находитесь в правильной директории
- Клонируем репозиторий - Клонируем репозиторий
```bash ```bash
git clone https://github.com/vvsu-rent-project/dev_rent.github git clone https://github.com/vvsu-rent-project/dev_rent.github
``` ```
- В консоли переходим в папку проекта - В консоли переходим в папку проекта
- Далее переходим на ветку unstable - Далее переходим на ветку unstable
```bash ```bash
git switch dev_unstable git switch dev_unstable
``` ```
### Клонирование проекта через GitHub Desktop ### Клонирование проекта через 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, открываем папку проекта и запускаем терминал - Открываем VS Code, открываем папку проекта и запускаем терминал
- В терминале переходим в папку pairent_backend - В терминале переходим в папку pairent_backend
```bash ```bash
cd pairent_backend cd pairent_backend
``` ```
- Создаем виртуальное окружение - Создаем виртуальное окружение
```bash ```bash
python -m venv venv python -m venv venv
``` ```
- Активируем виртуальное окружение. Активировать окружение нужно: когда запускаете сервер, устанавливаете зависимости, добавляете новое django приложение - Активируем виртуальное окружение. Активировать окружение нужно: когда запускаете сервер, устанавливаете зависимости, добавляете новое django приложение
```bash ```bash
venv\Scripts\activate venv\Scripts\activate
``` ```
- После активации, устанавливаем зависимости. - После активации, устанавливаем зависимости.
```bash ```bash
pip install -r requirements.txt pip install -r requirements.txt
``` ```