New config file and update README

README.md

@@ -4,11 +4,101 @@
   <img align="center" src="https://api.visitorbadge.io/api/visitors?path=https://github.com/Ralex91/Rahoot/edit/main/README.md&countColor=%2337d67a">
 </p>
 
-<h3 align="center">Rahoot is a straightforward and open-source clone of the Kahoot! platform, allowing users to host it on their own server for smaller events.</h3>
+## 🧩 What is this project?
 
-<hr>
+Rahoot is a straightforward and open-source clone of the Kahoot! platform, allowing users to host it on their own server for smaller events.
 
-<br>
-<h3 align="center">
-  Under development
-<h3>
+> ⚠️ This project is still under development, please report any bugs or suggestions in the [issues](https://github.com/Ralex91/Rahoot/issues)
+
+## ⚙️ Prerequisites
+
+- Node.js version 20 or higher
+
+## 📖 Getting Started
+
+1.  #### Clone the GitHub repository of your project.
+    ```bash
+    git clone https://github.com/Ralex91/Rahoot.git
+    cd ./Rahoot
+    ```
+2.  #### Install the dependencies using your preferred package manager
+
+    ```bash
+    npm install
+    ```
+
+    <br>
+    <hr>
+
+## 📦 Running the Application in Production Mode:
+
+1. #### Check websocket connfiguration in [config.mjs](config.mjs)
+
+   If you want the client to connect directly to the websocket server, edit the [config.mjs](config.mjs) file and change the localhost to your public IP address.
+
+   ```js
+   export const WEBSOCKET_PUBLIC_URL = "http://1.2.3.4:3100/"
+   export const WEBSOCKET_SERVER_PORT = 3100
+
+   // Rest of the config ...
+   ```
+
+2. #### Start the application
+
+   ```bash
+   npm run all
+   ```
+
+## ⚙️ Running the Application in Development Mode:
+
+```bash
+npm run all-dev
+```
+
+## 🔧 Configuration
+
+Configuration can be found in [config.mjs](config.mjs)
+
+```js
+const QUIZZ_CONFIG = {
+  password: "PASSWORD", // Manager password
+  subject: "Adobe", // Subject of the quiz
+  questions: [
+    { // Example question
+      question: "What is good answer ?", // Question
+      answers: [ // Possible answers
+        "No",
+        "Yes",
+        "No",
+        "No",
+      ],
+      image:
+        "https://images.unsplash.com/....", // Image URL (optional)
+      solution: 1, // Index of the correct answer (index starts at 0)
+      cooldown: 5, // Show question cooldown in seconds
+      time: 15, // Time to answer in seconds
+    },
+    ...
+  ],
+}
+```
+
+## 🤔 How to use
+
+- Go to [https://localhost:3000/manager](https://localhost:3000/manager) enter manager password.
+
+- Share link [https://localhost:3000/](https://localhost:3000/) and code on manager screen with your friends and get ready to play.
+
+- Once everyone is ready, start the game with button on the top left of the screen of manager.
+
+## 📝 Contributing
+
+- Create a fork
+
+- Create work branch (Example: githubUsername/featureName).
+
+- Commit and push your changes in the work branch.
+
+- Open a pull request.
+
+- Your pull request would be merged and changes will be reflected in the main repository.