kash / cubedesk

Community and timer for the Rubik's Cube
https://cubedesk.io
GNU General Public License v3.0
127 stars 8 forks source link
cubing javascript library puzzle rubiks rubiks-cube typescript

CubeDesk

Deploy CubeDesk to Production

CubeDesk is a free, open-source application that allows speedcubers to keep track of their times, visualize their stats, train hundreds of algorithms, and play with other cubers.

Home page of cubedesk

Bugs & Feature Requests

Before creating a bug or asking for a new feature, it's worthwhile to bring up your request on the Discord Server, where you may be able to get your issue resolved. If you'd like to report a bug, though, please go to the Issues page and create a New Issue with the bug label.

If you'd like to request a new feature or make suggestions, please use the Discussions page.

Development

If you'd like to contribute to CubeDesk, firstly, thank you; secondly, please follow the Development Onboarding instructions on the Wiki. Getting set up should only take less than 10 minutes!

Infrastructure

The visual below should give you a decent understanding of the infrastructure behind CubeDesk. For a full breakdown, checkout the Infrasture page on the Wiki.

CubeDesk's infrastructure

Support

CubeDesk is completely free to use, but, unfortunately, the cloud isn't. If you'd like to support CubeDesk, consider getting a Pro membership. You'll get tons of cool features and you'll be supporting development as well.

License

This project is licensed under the GPL license (version 3 or later). This means that this library is free to use, although you must publish any code that uses it (e.g. also put it on GitHub). See the full license for exact details.

I've selected this license in order to encourage the cubing community to work on software in a way so that everyone can contribute and extend each other's work.