https://github.com/henilp105/chesssync
ChessSync is a real-time chess synchronization application that leverages Redis for state management.
https://github.com/henilp105/chesssync
chess chess-ai python-chess redis
Last synced: 8 months ago
JSON representation
ChessSync is a real-time chess synchronization application that leverages Redis for state management.
- Host: GitHub
- URL: https://github.com/henilp105/chesssync
- Owner: henilp105
- License: mit
- Created: 2024-08-04T16:25:06.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-04T16:44:19.000Z (about 1 year ago)
- Last Synced: 2024-12-30T13:55:27.277Z (9 months ago)
- Topics: chess, chess-ai, python-chess, redis
- Language: Python
- Homepage: https://chess-sync.vercel.app
- Size: 8.68 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ChessSync
ChessSync is a real-time chess synchronization application that uses Redis for state management. It enables players to synchronize their chess games seamlessly across multiple devices and platforms. The application also integrates a chess engine for validating moves and providing game functionality.
live website: https://chess-sync.vercel.app/
## Features
- **Real-time Synchronization:** Sync game state in real-time across all connected devices.
- **Redis-based State Management:** Efficiently manage and store game states using Redis.
- **Chess Engine Integration:** Built-in chess engine for move validation.
- **Cross-Platform Support:** Play on different devices and platforms.
- **Move Validation:** Ensure all moves comply with chess rules.
## Installation
1. **Clone the Repository**
```bash
git clone https://github.com/henilp105/ChessSync.git
cd ChessSync
```
2. **Install Dependencies**
```bash
pip install -r requirements.txt
```
## Execution
To start the ChessSync application, run:
```bash
python main.py
```
## Configuration
You can configure ChessSync using environment variables. Create a `.env` file in the root directory with the following content:
```
REDIS_HOST=localhost
SECRET_KEY=your_secret_key_here
```
Ensure that Redis is running on the specified host and port.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.