update README and add .gitignore

This commit is contained in:
Александр Манаенков 2023-03-21 15:33:07 +10:00
parent be1462a8ef
commit e4dbb0a634
6 changed files with 51 additions and 4 deletions

27
.gitignore vendored Normal file
View File

@ -0,0 +1,27 @@
# Distribution / packaging
.Python
env/
venv/
build/
develop-eggs/
dist/
downloads/
eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
### Django ###
*.log
*.pot
*.pyc
__pycache__/
local_settings.py
.env
db.sqlite3

View File

@ -6,10 +6,15 @@
## Как начать работать?
Команды написаны под windows. Вводить в командную строку. Проверяйте, что в консоли вы находитесь в правильной директории
- Устанавливаем [python](https://www.python.org/downloads/) версия 3.11.1 и [git](https://git-scm.com/)
- [Настройте git](https://tproger.ru/curriculum/git-guide/). В основном нужно только ввести имя пользователя и почту, пароль запросит при клонировании
Если не хотите заморачиваться с терминалом. Советую использовать [GitHub Desktop](https://desktop.github.com/)
#### Клонирование и настройка проекта через терминал
Команды написаны под 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
@ -19,6 +24,7 @@ git clone https://github.com/vvsu-rent-project/dev_rent.github
```bash
git switch dev_unstable
```
- В консоли переходим в папку pairent_backend
- Создаем виртуальное окружение
```bash
python -m venv venv
@ -31,4 +37,18 @@ venv\Scripts\activate.bat
```bash
pip install -r requirements.txt
```
Поздравляю, вы завершили первый этап
#### Клонирование и настройка проекта через GitHub Desktop
- Заходим в настройки
![Заходим в настройки](README_img/1_step.png)
- Входим в аккаунт
![Входим в аккаунт](README_img/2_step.png)
- Клонируем репозиторий
![Клонируем репозиторий](README_img/3_step.png)
![Клонируем репозиторий](README_img/4_step.png)

BIN
README_img/1_step.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

BIN
README_img/2_step.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

BIN
README_img/3_step.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

BIN
README_img/4_step.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB