From 74e6476d4cbd67dbe562d0537f9193b301af3f9b Mon Sep 17 00:00:00 2001 From: xepaerz Date: Tue, 21 Mar 2023 00:13:10 +1000 Subject: [PATCH] update README.md --- README.md | 39 ++++++++++++++++++++++++++++++++++----- 1 file changed, 34 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d131559..f046367 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,34 @@ -# dev_rent -Тут 3 ветки -Сначала все кидаем в unstable -После обкатки и доработки можно переносить в stable -И в конце концов после тестов и положительного ревью можно заливаать в мэйн(по соглосованию с тимлидами и пм) +# Аренда квартир для студентов +В проекте есть три ветки: +- main — в эту ветку загружается код после положительного тестирования и ревью. +- dev_stable — в эту ветку загружается стабильный код, который будет использоваться в продашкене. +- dev_unstable — основная ветка для разработчиков. + +## Как начать работать? + +Команды написаны под windows. Вводить в командную строку. Проверяйте, что в консоли вы находитесь в правильной директории + +- Устанавливаем python версия 3.11.1 https://www.python.org/downloads/ и git https://git-scm.com/ +- Настройте git. В основном нужно только ввести имя пользователя и почту, пароль запросит при клонировании https://tproger.ru/curriculum/git-guide/ +- Клонируем репозиторий +```bash +git clone https://github.com/vvsu-rent-project/dev_rent.github +``` +- В консоли переходим в папку проекта +- Далее переходим на ветку unstable +```bash +git switch dev_unstable +``` +- Создаем виртуальное окружение +```bash +python -m venv venv +``` +- Активируем виртуальное окружение. Если работаете в VS Code, открывайте терминал в нем и используйте его. Активировать окружение нужно всегда, когда пишите код +```bash +venv\Scripts\activate.bat +``` +- После активации, устанавливаем зависимости. В этом же терминале! +```bash +pip install -r requirements.txt +``` +Поздравляю, вы завершили первый этап \ No newline at end of file