Skip to content

Latest commit

 

History

History
69 lines (56 loc) · 4.03 KB

README.md

File metadata and controls

69 lines (56 loc) · 4.03 KB

ft_transcendence

Overview

ft_transcendence is a web application designed for the mighty Pong contest. It enables users to engage in real-time multiplayer online Pong games while offering additional features such as chat and user account management.

Project Requirements

  • Backend: The project's backend is built using NestJS.
  • Frontend: The frontend is developed using React.js with TypeScript.
  • Database: PostgreSQL is used as the primary database.
  • Single-Page Application: The website is designed as a single-page application with support for browser navigation. Browser Compatibility: The website is compatible with the latest stable version of Google Chrome and one additional web browser of our choice.
  • Error Handling: The website ensures a smooth user experience with no unhandled errors or warnings.
  • Docker: The project can be launched with a single call to docker-compose up --build, including support for Docker in rootless mode for Linux.

Security Concerns

To ensure the security of our application, we've implemented the following measures:

  • Password Hashing: All passwords stored in the database are securely hashed.
  • SQL Injection Prevention: The website is protected against SQL injection attacks.
  • Server-side Validation: Forms and user inputs are validated on the server-side to prevent malicious input.

Note: Please note that sensitive information such as credentials and API keys are stored locally in a .env file and are not committed to the Git repository for security reasons.

User Account

  • OAuth Login: Users can log in using the OAuth system of the 42 intranet.
  • Unique Usernames: Users can choose a unique display name for their profile.
  • Avatar Upload: Users can upload avatars, with a default avatar provided for those who don't.
  • Two-Factor Authentication: Users can enable two-factor authentication for enhanced security.
  • Friends and Status: Users can add friends, see their current status, and view stats on their profile.
  • Match History: A comprehensive match history is available, including 1v1 games and ladder matches.

Chat

Our chat feature allows users to:

  • Create public, private, or password-protected chat channels.
  • Send direct messages to other users.
  • Block unwanted users to stop receiving messages.
  • Set channel passwords and manage channel administration.
  • Invite other users to play Pong games through the chat interface.
  • Access other player's profiles via the chat interface.

Game

The core feature of the website is playing Pong:

  • Users can play live Pong games directly on the website.
  • A matchmaking system allows users to find opponents automatically.
  • Customization options are available, including power-ups and different maps.
  • The game is responsive and faithful to the original Pong (1972).

ScreeShots:

Landing Page: localhost_5173_ Home: localhost_5173_home (11) Chat: localhost_5173_home (5) (1) localhost_5173_home (4) (1) Profile: localhost_5173_home (3) (1) LeaderBoard: localhost_5173_home (10) Game: localhost_5173_home (7) (2) localhost_5173_home (8) (1) localhost_5173_home (9) (1)