From 20a9c75bd1b736826c67530e1f0fff16ffbcb004 Mon Sep 17 00:00:00 2001
From: Moon Patel <95487062+moonpatel@users.noreply.github.com>
Date: Wed, 11 Oct 2023 23:34:56 +0530
Subject: [PATCH] Update README.md
Added description, technologies used and steps to run locally.
---
README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 56 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index cd768e2..e92672f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,57 @@
# ChessHub
-A web application for playing multiplayer chess
+ChessHub is a web application for chess enthusiasts that allows players to compete against each other.
+
+## Technologies used
+1. ReactJS
+2. MongoDB
+3. NodeJS
+4. ExpressJS
+5. Mantine
+6. Socket.IO
+7. Mongoose
+
+## Features
+1. Play chess with your friends
+2. Play with computer with customizable ELO
+3. View your game history
+4. Make friends
+5. Analyze your games
+
+## How to contribtute to this repository ?
+You can contribute to this repository by checking out existing issues or creating your own in the issue section (if you experience any bugs in the application or you want to propose a new feature).
+1. Star the repository
+2. Fork the repo. (Click on the fork button in the top right corner).
+3. Clone the forked repo to your local machine.
+```
+git clone https://github.com/moonpatel/ChessHub.git
+```
+4. Change the present working directory.
+```
+cd ChessHub
+```
+5. Create a new branch.
+```
+git checkout -b new-branch
+```
+6. Create a .env file in both frontend and backend directory according to the .env.example files with the required environment variables.
+7. Install the dependencies for frontend.
+```
+cd frontend
+npm install
+```
+8. Install the dependencies in the backend.
+```
+cd backend
+npm install
+```
+9. Start the frontend
+```
+cd frontend
+npm run dev
+```
+10. Start the backend
+```
+cd backend
+npm run dev
+```
+11. Visit http://localhost:5173 in your browser to view the application.