ilhamdev commited on
Commit
26ad920
·
verified ·
1 Parent(s): ece5841

Upload folder using huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +8 -84
README.md CHANGED
@@ -1,84 +1,8 @@
1
- # ChessHub
2
- ChessHub is a web application for chess enthusiasts that allows players to compete against each other.
3
-
4
- ![Capture](https://github.com/moonpatel/ChessHub/assets/95487062/d4bc47fe-9364-43e6-8a6e-081daee55d98)
5
-
6
-
7
- ## Technologies used
8
- <p>
9
- <a href="https://react.dev/"><img src="https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB" /></a>
10
- <a href="https://www.mongodb.com/"><img src="https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white" /></a>
11
- <a href="https://nodejs.org/en"><img src="https://img.shields.io/badge/Node%20js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white" /></a>
12
- <a href="https://expressjs.com/"><img src="https://img.shields.io/badge/Express%20js-000000?style=for-the-badge&logo=express&logoColor=white" /></a>
13
- <a href="https://socket.io/"><img src="https://img.shields.io/badge/Socket.io-010101?&style=for-the-badge&logo=Socket.io&logoColor=white" /></a>
14
- </p>
15
-
16
- ## Features
17
- 1. Play chess with your friends
18
- 2. Play with computer with customizable ELO
19
- 3. View your game history
20
- 4. Make friends
21
- 5. Analyze your games
22
-
23
- ## How to contribtute to this repository ?
24
- 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).
25
-
26
- ### Setting up the project locally
27
- 1. Make sure to star the repository before going ahead.
28
- 2. Fork the repo. (Click on the fork button in the top right corner).
29
- 3. Clone the forked repo to your local machine.
30
- ```
31
- git clone https://github.com/moonpatel/ChessHub.git
32
- ```
33
- 4. Change the present working directory.
34
- ```
35
- cd ChessHub
36
- ```
37
- 5. Create a new branch.
38
- ```
39
- git checkout -b new-branch
40
- ```
41
- 6. Create a .env file in both frontend and backend directory according to the .env.example files with the required environment variables. 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 <a href="https://stockfishchess.org/download/">stockfish</a> website and place it in backend/engine directory. Also add the path of the engine to the CHESS_ENGINE_PATH variable in .env file in backend directory.
42
- 7. Install the dependencies for frontend.
43
- ```
44
- cd frontend
45
- npm install
46
- ```
47
- 8. Install the dependencies in the backend.
48
- ```
49
- cd backend
50
- npm install
51
- ```
52
- 9. Start the frontend
53
- ```
54
- cd frontend
55
- npm run dev
56
- ```
57
- 10. Start the backend
58
- ```
59
- cd backend
60
- npm run dev
61
- ```
62
- 11. Visit http://localhost:5173 in your browser to view the application.
63
-
64
- ### Setting up project using docker (Recommended)
65
- There is an alternative option to set up the project using docker. Make sure you have docker and docker-compose installed on your system.
66
- 1. Fork the repo. (Click on the fork button in the top right corner).
67
- 2. Clone the forked repo to your local machine.
68
- ```
69
- git clone https://github.com/moonpatel/ChessHub.git
70
- ```
71
- 3. Change the present working directory.
72
- ```
73
- cd ChessHub
74
- ```
75
- 4. Add .env files to both your frontend and backend directories based on their respective .env.example templates (can be found inside the directories itself).
76
- 5. Build the docker images for frontend and backend.
77
- ```
78
- docker-compose build
79
- ```
80
- 6. Run the docker containers.
81
- ```
82
- docker-compose up
83
- ```
84
- 7. Visit the website from your browser -> http://localhost:5173
 
1
+ ---
2
+ title: ChessGame
3
+ emoji: 🌍
4
+ colorFrom: indigo
5
+ colorTo: purple
6
+ sdk: docker
7
+ pinned: false
8
+ ---