Skip to content

cosmodd/transcendence

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“ Transcendence

Transcendence is a web-based pong game that lets you play with other players online and play tournaments with a matchmaking system.

🧩 Modules

πŸ”Ά Major module (equivalent to 2 Minor)
πŸ”Ή Minor module

  • πŸ”Ά Use a Framework as backend [Python Django]
  • πŸ”Ή Use a database for the backend [PostgreSQL]
  • πŸ”Ή Use a frontend framework or toolkit [Bootstrap]
  • πŸ”Ά Standard user management, auth, users across tournaments
  • πŸ”Ά Implementing a remote authentication
  • πŸ”Ά Remote players
  • πŸ”Ά Live Chat
  • πŸ”Ά Implement 2FA and JWT

✍️ Contributing

Follow these steps to get started with the project:

  1. Clone the repository
# HTTPS
git clone https://github.com/cosmodd/transcendence.git

# SSH
git clone [email protected]:cosmodd/transcendence.git
  1. Create a virtual environment in the directory
cd transcendence
python3 -m venv venv
  1. Activate the virtual env
# Windows
.\venv\Scripts\activate

# MacOS / Linux
source ./venv/bin/activate
  1. Install the requirements
pip install -r ./backend/requirements.txt

Now you're ready to start contributing to the project!

πŸš€ Running the project

To run the project, you simply do the following in the root directory:

docker compose up -d

πŸ‘₯ Contributors

Name Github
mrattez cosmodd
pforesti dcdnce
mzaraa mzaraa
gpietrin fideloposte

About

πŸ“ An online pong game website

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •