Merge branch 'master' of https://github.com/shivansh-bhatnagar18/mult…

…iplayer-uno

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+## Description
+[Provide a brief description of the changes made in this pull request.]
+
+## Motivation and Context
+[Explain the motivation behind these changes and provide any relevant context.]
+
+## How to Test
+[Describe the steps to test the changes made in this pull request.]
+
+## Related Issues
+[If applicable, mention any related issues or pull requests.]
+
+## Checklist
+- [ ] I have tested these changes locally.
+- [ ] I have reviewed the code and ensured it follows the project's coding guidelines.
+- [ ] I have updated the documentation, if necessary.
+- [ ] I have assigned reviewers to this pull request.
+
+## Screenshots (if applicable)
+[If your changes include any visual updates, provide screenshots here.]

.github/issue_template.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]

CONTRIBUTING.md

@@ -1,4 +1,3 @@
-
 ---
 
 # Contributing to Multiplayer UNO Game
@@ -91,7 +90,7 @@ If any merge conflicts occur, you will need to resolve them manually. Code edito
 Now the local copy of the branch is synced with upstream/main. You need to force push these changes to origin, since the commit history has been rewritten.
 
 ```bash
-git push origin <branch-name> --force
+git push --force
 ```
 
 ### Editing commit history
@@ -139,7 +138,7 @@ After making the changes, you can continue the rebase process by running `git re
 
 When there are no more commits left, the rebase process will be complete.
 
-After all the commits have been applied, you can push the changes to your branch using `git push origin <branch-name> --force`. This will overwrite the commits in the remote branch in your forked repository with the changes you just made locally.
+After all the commits have been applied, you can push the changes to your branch using `git push --force`. This will overwrite the commits in the remote branch in your forked repository with the changes you just made locally.
 
 #### Tip
 VSCode provides a helpful UI to perform these operations. You can set the default text editor for Git to VSCode by running the following command:

INSTALLATION.md

@@ -75,14 +75,14 @@ cd multiplayer-uno
 4. Start the frontend development server:
 
     ```bash
-    npm start
+    npm run dev
     ```
 
-   The frontend application should now be running on `http://localhost:3000`.
+   The frontend application should now be running on `http://localhost:5173`.
 
 ## Running the Application
 
-With both the backend and frontend servers running, open your browser and navigate to `http://localhost:3000` to access the UNO game. You should be able to sign up, log in, create or join game rooms, and start playing.
+With both the backend and frontend servers running, open your browser and navigate to `http://localhost:5173` to access the UNO game. You should be able to sign up, log in, create or join game rooms, and start playing.
 
 ## Troubleshooting
 
@@ -91,7 +91,7 @@ If you encounter any issues during installation, consider the following steps:
 - **Check Dependencies**: Ensure that all dependencies are installed correctly by running `npm install` in both the `backend` and `frontend` directories.
 - **Environment Variables**: Ensure that your `.env` file contains the correct values for your MongoDB connection string and JWT secret.
 - **Server Logs**: Check the terminal output for any error messages from the backend or frontend servers.
-- **Port Conflicts**: Make sure that ports `5000` (backend) and `3000` (frontend) are not being used by other applications.
+- **Port Conflicts**: Make sure that ports `5000` (backend) and `5173` (frontend) are not being used by other applications.
 
 ## Contact
 

backend/eslint.config.js

@@ -0,0 +1,14 @@
+import jsdoc from 'eslint-plugin-jsdoc';
+
+export default [
+    {
+        files: ['**/*.js'],
+        plugins: {
+            jsdoc: jsdoc,
+        },
+        rules: {
+            'jsdoc/require-description': 'error',
+            'jsdoc/check-values': 'error',
+        },
+    },
+];

backend/gameStore.js

@@ -7,6 +7,7 @@ export function createGame() {
 }
 
 /**
+ *  Retrieves a game from the store using its id.
  *
  * @param {string} id Game id
  * @returns {GameEngine|null} GameEngine instance