From 58752a12447af9c41ed010fcb3ff5f96a6b280a6 Mon Sep 17 00:00:00 2001 From: Moon Patel <95487062+moonpatel@users.noreply.github.com> Date: Fri, 13 Oct 2023 03:16:50 +0530 Subject: [PATCH 1/2] Update README.md Instructions updated for local setup --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e92672f..39edb4d 100644 --- a/README.md +++ b/README.md @@ -49,9 +49,33 @@ npm install cd frontend npm run dev ``` -10. Start the backend +10. The stockfish chess engine binary in the repo is for Linux systems only. If you are not using Linux then download the required stockfish chess engine binary from + stockfish website. Also add the path of the engine to the CHESS_ENGINE_PATH variable in .env file in backend. +12. Start the backend ``` cd backend npm run dev ``` -11. Visit http://localhost:5173 in your browser to view the application. +12. Visit http://localhost:5173 in your browser to view the application. + +## Setting up project using docker +There is an alternative option to set up the project using docker. Make sure you have docker and docker-compose installed on your system. +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. Build the docker images for frontend and backend. +``` +docker-compose build +``` +6. Run the docker containers. +``` +docker-compose up +``` +7. Visit the website from your browser -> http://localhost:5173 From c8c5c3067092abd4a236b0d0518e471c6a79dce3 Mon Sep 17 00:00:00 2001 From: Moon Patel <95487062+moonpatel@users.noreply.github.com> Date: Fri, 13 Oct 2023 03:18:14 +0530 Subject: [PATCH 2/2] added image in README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 39edb4d..7d00520 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # ChessHub ChessHub is a web application for chess enthusiasts that allows players to compete against each other. +![Capture](https://github.com/moonpatel/ChessHub/assets/95487062/d4bc47fe-9364-43e6-8a6e-081daee55d98) + + ## Technologies used 1. ReactJS 2. MongoDB