Anduin Xue
81 lines
3.6 KiB
Markdown
81 lines
3.6 KiB
Markdown
# ChessServer
|
|
|
|
[](https://gitlab.aiursoft.com/aiursoft/ChessServer/-/blob/master/LICENSE)
|
|
[](https://gitlab.aiursoft.com/aiursoft/ChessServer/-/pipelines)
|
|
[](https://gitlab.aiursoft.com/aiursoft/ChessServer/-/pipelines)
|
|
[](https://manhours.aiursoft.com/r/gitlab.aiursoft.com/aiursoft/ChessServer.html)
|
|
[](https://chess.aiursoft.com)
|
|
[](https://hub.docker.com/r/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.com).
|
|
|
|
## Run in Ubuntu
|
|
|
|
The following script will install\update this app on your Ubuntu server. Supports Ubuntu 25.04.
|
|
|
|
On your Ubuntu server, run the following command:
|
|
|
|
```bash
|
|
curl -sL https://gitlab.aiursoft.com/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.com/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 10 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=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 | 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. |