ft_transcendence

Table of Contents:

• Description
• Tech Stack
• Modules
• Setup

Description

[ft_transcendence] is a web application that allows users to play a 3D version of the classic Pong game. The game is implemented using ReactJs and the backend is implemented using Django. Users can play against each other Localy , remotely, play against an opponent, create tournaments. The project also includes user management, authentication, and live chat.

Tech Stack

Category	Technology
Languages
Frontend
Backend
Database
Authentication
Containerization
Caching
Tools
**

Modules

• required:

Module	Type	Description	Done
Backend Framework	Major	Django as a backend Framework	✅
User Management	Major	Standard user management, authentication, users across tournaments	✅
Advanced 3D Techniques	Major	The Pong game is implemented using Three.js	✅
Remote Players	Major	Users can play against each other remotely	✅
Remote Authentication	Major	OAuth 2.0 authentication with 42	✅
Live Chat	Major	Users can send direct messages to other users	✅
Server-Side Pong	Major	Replacing Basic Pong with Server-Side Pong	✅
Database Backend	Minor	PostgreSQL as a database backend	✅
Browser Compatibility	Minor	The Web App should be compatible with all major browsers	✅

• stuff i added:

Module	Description	Done
Real-Time Notifications	Users can receive real-time notifications (game invites, new chat Messages...)	✅
Resumable Games	Users can resume games and tournaments where they left off	✅
Games History	Users can see All the games they played (local, online, tournament)	✅

Setup

1. Clone the repository

git clone https://github.com/aoutifrak/ft_transcendence.git

2. Change the directory

cd ft_transcendence

3. replace HOST_MC with your IP address in example.env and SERVER_NAME files and rename them to .env .
4. Run the following command to start the project

docker compose up

Note: Login with 42 will not work for you as it requires a 42 API key.