CubeDesk
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.
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!
Local sample data
After signing up in your local app, run:
pnpm seed:dev --username YOUR_LOCAL_USERNAMEThe command reads .env and requires NODE_ENV=development. It adds roughly 4,000
solves over 90 days across 3x3, 2x2, 4x4, and Pyraminx, with improving times, rest
days, DNFs, and +2 penalties. Reload the app to populate Stats, Solves, and the four
[Dev seed] sessions. Select a seeded session in the timer to see its history.
Community and match records are not seeded.
Existing data is preserved. Stable IDs make reruns skip records already inserted;
they do not refresh their dates. To regenerate a fresh history, delete the four
[Dev seed] sessions and their solves through the local app, then rerun.
The script is manual and is not wired into app startup, builds, or migrations.
It refuses remote hosts, production/unset environments, alternate database secret
settings, and URL query parameters. Only localhost, 127.0.0.1, or ::1 with a
database named cubedesk, cubedesk_dev, or cubedesk_test are accepted. Use an
actual local PostgreSQL instance; a localhost tunnel to a remote database cannot
be distinguished from a local database by its URL.
Infrastructure
Production builds and Sentry
pnpm build uses Vite to build the browser assets into dist/ and the Node server
into build/server/. The server build bundles all of its dependencies, so the
Docker image only contains Node and build/server/. pnpm start runs the compiled
server; pnpm dev keeps the existing development server and Vite hot reload.
Production runs on ECS Fargate. Pushing to main builds on a CodeBuild-hosted
GitHub Actions runner, uploads dist/ and public/ to S3, runs migrations, and
deploys a new task definition revision with only the image changed. Runtime
environment variables (ENV, DATABASE_URL, REDIS_URL, ...) live in the ECS task
definition, not in the repo or the image.
Deployments use the GitHub Actions SENTRY_AUTH_TOKEN secret to upload source maps
to the frontend and backend projects in the cubedesk Sentry organization.
Both builds and the runtime use the same RELEASE_NAME. The token needs permission
to upload source maps and manage releases for both projects. It is only available
to the build step and never reaches the image.
Local builds without SENTRY_AUTH_TOKEN skip uploading. Maps are generated with
embedded source content and deleted after uploading, before publishing assets to the
CDN or packaging the server. Upload failures stop deployment.
SENTRY_DSN is the separate runtime setting that enables backend error reporting.
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.
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.