README.md

YaRaceOnline

Contents

• About

• Deployment instructions

  • Cloning project
  • Activation venv
  • Requirements
  • .Env
  • Running

• Database

  • ER-diagram

About

This project is the second credit project at the Lyceum Academy Yandex. This is a racing game that can be played alone or together online over a local network.

---

Deployment instructions

1. Cloning project from GitHub

1.1 Run this command

git clone https://github.com/GrishaTS/YaRaceOnline-Game2023YandexProject

2. Creation and activation venv

2.1 First of all, from root directory run this command

python -m venv venv

2.2 Then run this command to activate venv

Mac OS / Linux

source venv/bin/activate

Windows

.\venv\Scripts\activate

3. Installation all requirements

3.3 Run this command

pip install -r requirements.txt

4. Generate file with virtual environment variables (.env)

4.1 Generate file '.env' in root directory with such structure

IPv4=YOUR-IPv4-address
DATABASE=YOUR-DATABASE-FILE

5. Running project

5.1 Run this command

python main.py

---

ER-diagram

---