Merge pull request #122 from CS3219-AY2324S1/readme-update

Update README.md

.github/workflows/google.yml

@@ -67,7 +67,7 @@ jobs:
 
     - name: Build and Push Docker Images
       run: |
-        microservices=("eval-service")
+        microservices=("")
         for service in "${microservices[@]}"
         do
           echo "Building image for $service"

README.md

@@ -1,2 +1,48 @@
-[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-24ddc0f5d75046c5622901739e7c5dd533143b0c8e959d652212380cedb1ea36.svg)](https://classroom.github.com/a/6BOvYMwN)
-# AssignmentTemplate
+# Leetcode Racer
+
+## Project Overview
+
+Welcome to Leetcode Racer, an engaging and competitive coding platform inspired by LeetCode. Leverage your coding skills, compete with others, and enhance your problem-solving abilities. Our unique matchmaking system pairs participants based on proficiency, fostering a challenging and fair competition.
+
+## Accessing the Frontend
+
+Visit [Leetcode Racer](http://34.68.28.7:3000/) to access the platform.
+
+## Getting Started (for grading purposes only)
+
+To simulate a pair of opponents and test the functionality of Leetcode Racer, follow these steps:
+
+1. **Create Two Accounts:**
+   - Visit [Leetcode Racer](http://34.68.28.7:3000/) in your web browser.
+   - Sign up for a new account as the first opponent.
+   - Open an incognito browser window and sign up for a second account as the second opponent.
+
+2. **Match the Opponents:**
+   - Log in to the first account in the regular browser window.
+   - Log in to the second account in the incognito browser window.
+   - In both browsers, choose the same coding category and question difficulty.
+   - Initiate the matchmaking process to find an opponent.
+
+3. **Start Coding:**
+   - Once the opponents are matched, they will proceed to the editor and question room.
+   - Both users can click "I'm ready" to proceed to the next screen.
+
+4. **Chat and Discuss:**
+   - In the chat room, users can communicate with each other.
+   - Discuss your approach to the problem, share tips, and talk about your coding strategies.
+
+By following these steps, you can simulate a pair of opponents, test the matchmaking functionality, and evaluate the collaborative coding experience on Leetcode Racer.
+
+## Contributing
+
+If you're interested in contributing to Leetcode Racer, please check out our [contribution guidelines](CONTRIBUTING.md). We welcome bug reports, feature requests, and pull requests.
+
+## Issues and Support
+
+Encountered an issue or need support? [Create an issue](https://github.com/your-username/leetcode-racer/issues) on the GitHub repository.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+Happy coding and racing on Leetcode Racer! 🚀