- Play Ping Pong matches and tournaments, and chat live with your friends!
| Category | Technology |
|---|---|
| Server |  |
| Backend Framework |  |
| Database |  |
| Containerization |  |
| Frontend |    |
| Authentication |  |
| Monitoring and Logging |     |
| Languages |     |
| Development Tools |    |
| Design |  |
# to see all available commands
$> make
# build images and run containers
$> make start
# to build docker images
$> make build
# to run docker containers
$> make up
# removes containers, volumes... and restart everything
$> make re
# generating some users and matches
$> make data-generator
After running all the containers, you can access https://localhost
- Sign Up: This use case allows a new user to create an account on the website. Users will provide necessary information such as username, email, and password to register themselves.
- Sign In: This use case enables registered users to authenticate themselves into the system by providing their username/email and password.
- Dashboard: Upon signing in, users are directed to their dashboard. The dashboard provides an overview of the user's profile, activities, notifications, and other relevant information.
- Play Game: Users can engage in playing games available on the website. This use case allows users to select and participate in various games, such as ping pong, available on the platform.
- Chat: Users can communicate with each other through the chat feature provided by the website. This use case enables users to send and receive messages, emojis, and other media in real-time.
- View Achievement: Users can view their achievements and milestones attained while using the website. This use case allows users to track their progress and accomplishments within the platform.
- Logout: This use case allows users to securely log out of their account, ensuring the privacy and security of their data.
- Add Friends: Users can expand their social network by adding other users as friends. This use case enables users to send and accept friend requests, thereby connecting with each other on the platform.
- View Leaderboard: Users can view the leaderboard to see rankings based on various criteria, such as game scores, achievements, or activity levels. This use case provides users with a sense of competition and allows them to compare their performance with others.
- Update Profile: Users can modify and update their profile information as needed. This use case allows users to edit their profile details, such as username, profile picture, bio, and other preferences.
- Manage User Accounts: Admins can manage user accounts, including creating new accounts, updating user information, and deactivating or deleting accounts if necessary.
- Manage Admin Functions: Admins have access to additional functionalities for managing the website, such as managing system settings, controlling access permissions, and handling reported issues or disputes.
| Feature | Module | Major/Minor | Supported | Progress |
|---|---|---|---|---|
| Mandatory Part | ||||
| Minimal technical requirement | ✅ | Done | ||
| Game | ✅ | Done | ||
| Security Concerns and Recommendations | ✅ | Done | ||
| Web | ||||
| Use a Framework as backend. | Major | ✅ | Done | |
| Use a database for the backend. | Minor | ✅ | Done | |
| User Management | ||||
| Standard user management, authentication, users across tournaments. | Major | ✅ | Done | |
| Implementing a remote authentication. | Major | ✅ | Done | |
| Gameplay and user experience | ||||
| Remote players | Major | ✅ | Done | |
| Game Customization Options | Minor | ✅ | Done | |
| Live chat | Major | ✅ | Done | |
| AI-Algo | ||||
| User and Game Stats Dashboards | Minor | ✅ | Done | |
| Cybersecurity | ||||
| Implement Two-Factor Authentication (2FA) and JWT. | Major | ✅ | Done | |
| Devops | ||||
| Infrastructure Setup for Log Management. | Major | ✅ | Done | |
| Monitoring system. | Minor | ✅ | Done | |
| Graphics | ||||
| Use of advanced 3D techniques. | Major | ✅ | Done |
- Website must be a single-page application. use the Back and Forward buttons of the browser.
- Compatible with the latest stable up-to-date version of Google Chrome.
- No unhandled errors and no warnings when browsing the website.
- Everything must be launched with a single command line (e.g docker-compose up --build)
| Requirement | Description | Implementation |
|---|---|---|
| Live Pong game | Users play Pong against each other directly on the website using the same keyboard. | Stack: FrontEnd module |
| Remote players module | Enhances gameplay by enabling players to compete against remote opponents. | Optional: Remote players module |
| Tournament system | Allows players to compete in a tournament format, displaying matchups and player order clearly. | Stack: Backend module |
| Registration system | Players input aliases at the start of each tournament. Aliases reset for new tournaments. | Stack: Backend module |
| Standard User Management module | Provides flexibility in managing user registration and aliases. | Optional: Standard User Management module |
| Matchmaking system | Organizes matchups for participants and announces next fights. | Stack: Backend module |
| Adherence to rules | All players, including AI, must adhere to the same rules, including identical paddle speed. | Stack: Backend module |
| Frontend development | Develop game within default frontend constraints or utilize FrontEnd module. | Stack: FrontEnd module |
| Override option with Graphics module | Provides option to override default frontend with Graphics module for enhanced visual aesthetics. | Optional: Graphics module |
| Prohibition on third-party tools | Prohibits use of libraries or frameworks that replace necessary functions. Justification required. | Strictly Prohibited |
| Simplification with justified tools/resources | Recommended to use tools/resources for simplification, but they must be justified. | Allowed and recommended; justification required |
| Security Concern | Recommendation |
|---|---|
| Password storage | Hash passwords before storing them in the database. Use a strong password hashing algorithm. |
| Protection against SQL injections/XSS | Implement measures to sanitize and validate user input to prevent SQL injections and Cross-Site Scripting (XSS). |
| HTTPS connection | Enable HTTPS connection for all aspects of the website. Utilize wss instead of ws for WebSocket connections. |
| Form and user input validation | Implement validation for forms and any user input, either on the client-side within the base page or on the server-side if a backend is employed. |
- Framework: Django
- Constraints: Utilize Django for backend development.
- Database: PostgreSQL
- Constraints: Utilize PostgreSQL for backend database instances. Ensures data consistency and compatibility.
- Features:
- Secure user subscription.
- Secure user login.
- Selection of unique display names for tournaments.
- User information update functionality.
- Avatar upload with default option.
- Friend addition and online status viewing.
- User profile stats display (e.g., wins and losses).
- Match History for 1v1 games with dates and details.
- Authentication System: OAuth 2.0 with 42
- Objectives:
- Integrate OAuth 2.0 authentication system for secure sign-in.
- Obtain necessary credentials and permissions from the authority.
- Implement user-friendly login and authorization flows adhering to best practices.
- Ensure secure exchange of authentication tokens and user information.
- Objectives:
- Description: Allows two distant players to access the same website and play the same Pong game. Consider network issues like disconnection or lag for the best user experience.
- Description: Provides customization options for all available games on the platform.
- Key Features:
- Offer customization features like power-ups, attacks, or different maps.
- Allow users to choose a default version of the game for a simpler experience.
- Ensure customization options are available and applicable to all games.
- Implement user-friendly settings menus for adjusting game parameters.
- Maintain consistency in customization features across all games.
- Description: Implements a chat system for users with various functionalities.
- Key Features:
- Allow users to send direct messages to other users.
- Enable user blocking to stop receiving messages from blocked accounts.
- Provide the ability to invite other users to play Pong through the chat interface.
- Integrate tournament system notifications for upcoming games.
- Allow access to other players' profiles through the chat interface.
- Goal: Introduce user-friendly dashboards displaying statistics for individual users and game sessions.
- Features:
- Create separate dashboards for user and game session statistics.
- Implement intuitive and informative user interfaces.
- Utilize data visualization techniques such as charts and graphs.
- Allow users to access and explore their gaming history and performance metrics.
- Additional metrics can be added as deemed useful.
| Module Type | Description | Key Features |
|---|---|---|
| Major | Implement Two-Factor Authentication (2FA) and JWT | - Introduce Two-Factor Authentication (2FA) for enhanced security. |
| - Utilize JSON Web Tokens (JWT) for secure authentication and authorization. | ||
| - Offer a user-friendly setup process for enabling 2FA. |
| Module Type | Description | Key Features |
|---|---|---|
| Major | Infrastructure Setup with ELK (Elasticsearch, Logstash, Kibana) for Log Management | - Deploy Elasticsearch for efficient log data storage and indexing. |
| - Configure Logstash to collect, process, and transform log data. | ||
| - Set up Kibana for log data visualization and insights. | ||
| - Define data retention policies and implement security measures. | ||
| Minor | Monitoring System with Prometheus and Grafana | - Deploy Prometheus for monitoring and alerting. |
| - Configure Grafana for custom dashboards and visualizations. | ||
| - Set up alerting rules and ensure proper data retention. | ||
| - Implement secure authentication and access control. |
- Objective: Enhance the visual aspects of the Pong game using advanced 3D techniques.
- Key Features:
- Implement advanced 3D graphics techniques to elevate the visual quality of the Pong game.
- Utilize ThreeJS/WebGL technology to create stunning visual effects.
- Enhance gameplay experience with visually engaging and captivating elements.
- Ensure compatibility and optimal performance by integrating ThreeJS/WebGL.