Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aiursoftweb/chessserver
ChessServer is just a simple web-based chess server. Based on WebSocket. Can be played with sharing link with friends. No sign up required. Source at https://gitlab.aiursoft.cn/aiursoft/chessserver
https://github.com/aiursoftweb/chessserver
chess chess-server docker game game-development server web
Last synced: about 5 hours ago
JSON representation
ChessServer is just a simple web-based chess server. Based on WebSocket. Can be played with sharing link with friends. No sign up required. Source at https://gitlab.aiursoft.cn/aiursoft/chessserver
- Host: GitHub
- URL: https://github.com/aiursoftweb/chessserver
- Owner: AiursoftWeb
- License: other
- Created: 2023-11-25T09:32:04.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-10-22T07:00:28.000Z (17 days ago)
- Last Synced: 2024-10-23T10:04:47.954Z (16 days ago)
- Topics: chess, chess-server, docker, game, game-development, server, web
- Language: C#
- Homepage: https://chess.aiursoft.cn/
- Size: 1.41 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ChessServer
[](https://gitlab.aiursoft.cn/aiursoft/ChessServer/-/blob/master/LICENSE)
[](https://gitlab.aiursoft.cn/aiursoft/ChessServer/-/pipelines)
[](https://gitlab.aiursoft.cn/aiursoft/ChessServer/-/pipelines)
[](https://gitlab.aiursoft.cn/aiursoft/ChessServer/-/commits/master?ref_type=heads)
[](https://chess.aiursoft.cn)
[](https://hub.aiursoft.cn/#!/taglist/aiursoft/chessserver)
ChessServer is just a simple web-based chess server. Based on WebSocket. Can be played with sharing link with friends. No sign up required.
## Try
Try a running ChessServer [here](https://chess.aiursoft.cn).
## Run in Ubuntu
The following script will install\update this app on your Ubuntu server. Supports Ubuntu 22.04.
On your Ubuntu server, run the following command:
```bash
curl -sL https://gitlab.aiursoft.cn/aiursoft/chessserver/-/raw/master/install.sh | sudo bash
```
Of course it is suggested that append a custom port number to the command:
```bash
curl -sL https://gitlab.aiursoft.cn/aiursoft/chessserver/-/raw/master/install.sh | sudo bash -s 8080
```
It will install the app as a systemd service, and start it automatically. Binary files will be located at `/opt/apps`. Service files will be located at `/etc/systemd/system`.
## Run manually
Requirements about how to run
1. Install [.NET 8 SDK](http://dot.net/) and [Node.js](https://nodejs.org/).
2. Execute `npm install` at `wwwroot` folder to install the dependencies.
3. Execute `dotnet run` to run the app.
4. Use your browser to view [http://localhost:5000](http://localhost:5000).
## Run in Microsoft Visual Studio
1. Open the `.sln` file in the project path.
2. Press `F5` to run the app.
## Run in Docker
First, install Docker [here](https://docs.docker.com/get-docker/).
Then run the following commands in a Linux shell:
```bash
image=hub.aiursoft.cn/aiursoft/chessserver
appName=chessserver
sudo docker pull $image
sudo docker run -d --name $appName --restart unless-stopped -p 5000:5000 -v /var/www/$appName:/data $image
```
That will start a web server at `http://localhost:5000` and you can test the app.
The docker image has the following context:
| Properties | Value |
|-------------|-------------------------------------|
| Image | hub.aiursoft.cn/aiursoft/chessserver|
| Ports | 5000 |
| Binary path | /app |
| Data path | /data |
| Config path | /data/appsettings.json |
## How to contribute
There are many ways to contribute to the project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.
Even if you with push rights on the repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean and your workflow cruft out of sight.
We're also interested in your feedback on the future of this project. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.