Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nixigaj/schackmatt
University assignment | A web based chess game.
https://github.com/nixigaj/schackmatt
chess game mit-license nodejs typescipt university-assignment
Last synced: 1 day ago
JSON representation
University assignment | A web based chess game.
- Host: GitHub
- URL: https://github.com/nixigaj/schackmatt
- Owner: nixigaj
- License: mit
- Created: 2023-02-07T13:09:37.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-23T15:39:52.000Z (about 1 year ago)
- Last Synced: 2023-11-23T16:35:45.020Z (about 1 year ago)
- Topics: chess, game, mit-license, nodejs, typescipt, university-assignment
- Language: TypeScript
- Homepage:
- Size: 1.34 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Schackmatt
A web based chess game. Play with your friends on any device with a web browser supporting modern web standards. The entire game is currently client-side only, but multiplayer support is planned for the future. A live production demo is available at [schackmatt.erix.dev](https://schackmatt.erix.dev).
## Building and running
Only tested on Linux and macOS. [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) is recommended for building and running on Windows.
### Dependencies
* Git
* NodeJS
* npm
### Build
Clone the repository using:
```
git clone https://github.com/nixigaj/schackmatt.git
cd schackmatt
```
Install the dependencies with `npm install`.
Build with `npm run build`. The resulting build is located inside the `./dist` directory.
### Run
Run the React server on port `5173` with `npm start`. Your instance should now be accessible at [`http://localhost:5173`](http://localhost:5173) in any modern web browser.
For production deployments it is recommended that you use a web server like [Nginx](https://nginx.org/) with a reverse proxy to provide TLS encryption.
### Testing
Run the test suite with `npm run test`.
## License
Copyright © 2022 Erik Junsved, Frithiof Georgii Hellberg and Martin Ek
Licensed under the MIT license ([LICENSE](LICENSE))