Documentation/Module choice and readiness

[liocle]

Project Evaluation Checklist

Minimal Technical Requirements

• [x] Ensure the frontend is developed using pure vanilla JavaScript (unless overridden by a module).
• [x] Make the website a Single-Page Application (SPA) with functional Back and Forward browser buttons.
• [x] Ensure compatibility with the latest stable version of Google Chrome.
• [ ] Prevent unhandled errors or warnings during navigation.
• [x] Ensure the entire project can be launched with a single command using Docker (docker-compose up --build).
• [x] If using Docker in clusters, ensure Docker runtime files are in /goinfre or /sgoinfre.
• [x] Avoid "bind-mount volumes" with non-root UIDs in Docker containers.

Game Requirements

• [x] [Note: Overriden by remote player module] Allow users to participate in a live Pong game against another player using the same keyboard.
• [ ] Implement a tournament system for multiple players, displaying the match order.
• [x] Include a registration system where players input their alias names at the start of a tournament.
• [x] Implement a matchmaking system for tournament organization.
• [x] Ensure all players, including AI, follow identical rules (e.g., paddle speed).
• [x] Capture the essence of the original Pong game (1972) in the design, adhering to frontend constraints.

Security Concerns

• [x] Hash any passwords stored in the database.
• [x] Protect the website against SQL injections and XSS attacks.
• [x] Enable HTTPS connections for all backend features, using WSS instead of WS.
• [x] Implement validation for all forms and user input.
• [x] Store credentials, API keys, and environment variables in a .env file, ignored by Git.

Major Modules

• [x] Use a Framework as Backend (1.0)
• [x] User Management: Implementing Remote Authentication (1.0)
• [ ] Gameplay and User Experience: Remote Players (1.0)
• [ ] AI-Algo: Introduce an AI Opponent (1.0)
• [ ] Server-Side Pong: Replacing Basic Pong with Server-Side Pong and Implementing an API (1.0)
• [x] DevOps: Infrastructure Setup for Log Management (1.0)

Minor Modules

• [x] Use a Database for the Backend (0.5)
• [x] Accessibility: Expanding Browser Compatibility (0.5)

Eval Sheet Focus

• [ ] Preliminary Tests

  • [ ] Ensure all credentials, API keys, and environment variables are in a .env file.
  • [ ] Ensure the docker-compose file is at the root of the repository.
  • [ ] Run the docker-compose up --build command to ensure everything builds and runs without errors.

• [ ] Basic Checks

  • [ ] Ensure the website is available.
  • [ ] Verify that the user can subscribe to the website.
  • [ ] Ensure registered users can log in.
  • [ ] Confirm that the website is a Single Page Application (SPA) with functional "Back" and "Forward" buttons.
  • [ ] Ensure the website can be browsed using the latest version of Chrome.

• [ ] Security Checks

  • [ ] Ensure the website is secured and TLS is implemented if necessary.
  • [ ] Verify that passwords are hashed in the database.
  • [ ] Ensure there is server-side validation/sanitization on all forms and user inputs.
  • [ ] Thoroughly test security measures to ensure they are properly implemented.

• [ ] Gameplay Checks

  • [ ] Ensure the game is playable and respects the original Pong game mechanics.
  • [ ] Provide intuitive controls or clear instructions.
  • [ ] Implement an end-game screen or ensure the game page exits when the game is over.

• [ ] Lag & Disconnection Handling

  • [ ] Ensure the game does not crash during lags or disconnections.
  • [ ] Implement handling for unexpected disconnections (e.g., pause, reconnect).
  • [ ] Allow lagging users to catch up with the match.

• [ ] Modules Verification

  • [ ] Verify that each major module is functioning correctly.
  • [ ] Ensure there are no errors in the implementation of the modules.
  • [ ] Confirm that the purpose of each module is understood and well explained.
  • [ ] Ensure each module is thoroughly demonstrated and explained during evaluation.

Submission and Peer-Evaluation

• [ ] Ensure all work is committed to the Git repository.
• [ ] Double-check file names and repository structure.
• [ ] Make sure the project complies with all the requirements before submission.
• [ ] Make sure only Kibana and Nginx have exposed ports to outside.
• [ ] Make sure everything works on the school's computers.

[liocle]

⚠️ 👀 ☝ @pixelsnow @linhtng @wengcychan @djames9

The above ticket is a somewhat simplified version, specifically for the modules we choose, of the markdown file below that I let into it's own branch. Please check it out, and update whatever you feel should be updated. 👇

https://github.com/BeePong/42_transcendence/blob/Documentation/065-Evaluation-checklist/Evaluation_Checklist.md