35 lines
1.5 KiB
Markdown
35 lines
1.5 KiB
Markdown
# ShareChess
|
|
|
|
This repo contains the source code for [sharechess.github.io](https://sharechess.github.io/).
|
|
|
|
|
|
|
|
## About
|
|
|
|
[ShareChess](https://sharechess.github.io/) is a free, open source website that allows you to share chess games as self-contained replay links (the whole game is stored in the url without the need for a database), PNG images, or GIF / MP4 / WebM animations.
|
|
|
|
The website provides a high variety of chessboard and piece designs to serve as an open alternative for commercial chess GIF makers.
|
|
|
|
## Installation
|
|
|
|
Latest build is available on [github.com/sharechess/sharechess.github.io](https://github.com/sharechess/sharechess.github.io) and is ready to deploy on any hosting service (if you want to self-host the project).
|
|
|
|
For development:
|
|
|
|
- fork this repo and clone the fork to your local environment,
|
|
- go to the project's directory and run `npm i` (requires Node 16 LTS or higher, available [here](https://nodejs.org/en/)),
|
|
- run `npm start` - it will start the development server,
|
|
- start coding ;)
|
|
|
|
Preview of the current dev version is available here: [sharechess-dev.netlify.app/](https://sharechess-dev.netlify.app)
|
|
|
|
## Contributors
|
|
|
|
[](https://github.com/sharechess/sharechess/graphs/contributors)
|
|
|
|
## License
|
|
|
|
The project is under open [GNU GPL V3.0 license](/LICENSE.md).
|
|
|
|
Some of the assets are under separate licenses. Full list of credits, copyrights and licenses is located here: [CREDITS](/public/CREDITS.md).
|