The purpose of ft_transcendence is to familiarize us with web developement by creating a version of the original Pong (1972) and to render a fullstack website using pure vanilla JavaScript for the Frontend, Python for the Backend and Docker for containerizing the application, which aids in deploying and running the application consistently across different environments.
Mandatory part:
- Frontend developed using pure vanilla JavaScript
- Website must be a single-page-application
- Website must be compatible with the latest stable version of Google Chrome
- Everything must be launched with a single command line to run docker containers example:
docker-compose up --build - Pong game:
- Keys to move paddle in Pong game:
Wmove upSmove down
- Keys for LOCAL match (2nd player):
↑move up↓move down
- Tournament (4 players in total facing each other)
- Keys to move paddle in Pong game:
7 Modules chosen:
- Major module: Use a Framework as backend Django
- Minor module: Use a toolkit for the Frontend Bootrstrap
- Minor module: Use a database for the backend and more PostgreSQL
- Major module: Standard user management, authentication, users across tournaments
- User can subscribe to the website in a secure way
- Restered user can log in in a secure way
- User can update their information
- Users can upload an avatar, with a default option if none is provided
- User can add others as friends and view their online status
- User profiles display stats, such as wins and losses
- Each user has a match history
- Major module: Remote players (have players connected to the website in different computers)
- Major moduel: Live Chat
- User should be able to send direct messages to other users
- User should be able to block other users
- User should be able to invite other users to play a Pong game
- User should be able to access other players profiles
- Major module: Implement Two-Factor-Authentication (2FA) and JWT
- Implement 2FA as an additional layer of security
- Utilize JSON Web Tokens as a secure metho for authentication and authorization ensuring that user sessions and access to resources are managed securely
- Provide a user-friendly setup process for enabling 2FA (QR code using Google Authenticator)
- Ensure that JWT tokens are issued and validated securely
- Major module: Replacing Basic Pong with Server-Side Pong and Implementing an API
- Develop server-side logic for the Pong game to handle gameplay, ball movement, scoring and player interactions
- Create an API that exposes the necessary resources and endpoints to interact with the Pong game allowing partial usage of the game via the Command-Line Interface (CLI) and web interface
Clone repository and run docker:
git clone [email protected]:mariav7/ft_transcendence_42project.git
cd ft_transcendence_42project Warning
You must create an .env file at the root of the project
Example of an .env file:
DEBUG=True
SECRET_KEY=S*CR*T
POSTGRES_USER=root
POSTGRES_PASSWORD=12345
POSTGRES_DB=trs
POSTGRES_HOST=db
POSTGRES_PORT=5432
PROTOCOL=https
HOST_IN_USE=localhost
FRONTEND_PORT=5173
BACKEND_PORT=8000
ADMIN=god
PASSADMIN=12345
[email protected]
Run docker and create containers:
make upOpen Google Chrome and visit https://localhost:5173/, enjoy!:
google-chrome https://localhost:5173/