Cuby Solve API is a Python-based web application that provides an API to solve Rubik's cubes. Built using the Flask framework and leveraging the Kociemba algorithm, this API offers efficient and accurate cube solving capabilities for the Cuby ecosystem.
- Cuby Client - Main desktop application
- Cuby Mobile App - Mobile version
- Cuby Recognition API - Color detection API
- Cuby Capture API - Cube state capture API
- Cuby Capture Website - Web interface
- 🎯 Fast cube solving using Kociemba algorithm
- 🔄 RESTful API endpoints
- ⚡ Optimized solving times
- 🛡️ Robust error handling
- 🐳 Docker support
- 📝 Comprehensive documentation
- Python 3.12
- pip
- Docker (optional)
- Clone the repository:
git clone https://github.com/Cuby-Project/Cube-solve-API.git- Install dependencies:
pip install -r requirements.txt- Run the application:
python run.pyThe application will be available at http://127.0.0.1:5000/.
Follow the steps in the Docker Guide to run the application using Docker.
Make a GET request to the /solve/<cubeString> endpoint where cubeString is a string representation of the Rubik's cube.
Example:
curl http://127.0.0.1:5000/solve/your-cube-stringResponse:
{
"solution": "R U R' U'",
"moves": 4,
"time": 0.123
}Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
- Enhanced solving algorithms
- Additional cube type support
- Performance optimizations
- Extended API endpoints
- WebSocket support for real-time solving
This project is licensed under the MIT License - see the LICENSE file for details.
quentinformatique