CubePB is a website for storing and showcasing your personal bests in cubing-related events.
The project is actively being developed and we welcome any contributions! Please join our Discord server if you'd like to help out in any way. You can also join the cubing slack to learn more about the cubing organization and how you can get involved.
To familiarize yourself with the project, we would recommend checking out the frontend client readme. There, you will find instructions on how to set up the client and get it working on your local computer, where you will be able to make changes and see the effects immediately.
The backend API source code can be found here. However, we would strongly recommend using the official live API at https://api.cubepb.com instead of hosting the API locally, due to numerous requirements of setting up the local testing environment.
The backend API uses GiraffeQL as the query language. It expose a schema file that roughly describe the backend models and what query operations can be performed. The TypeScript schema file can be found here. By pasting the schema.ts file into a code editor like VSCode, you can use the Query Builder located at the top of the file to formulate GiraffeQL queries.
This project is licensed under the GPL license (version 3 or later). This means that the code 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.
We'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.