The best online solution for head-to-head speedcubing.

---

Support the Project

Though this is a community project, I still pay for the site to be hosted. Because of the real-time communication, extra juice is required to reliably run the service. I pay for all of this out of pocket. Because the service will always remain free, I rely on donations to keep the service alive. Any donations are greatly appreciated!

Features

• ⚡ Fast & Easy - Join a room with one click
• 💪 Stable - Built to last
• 📱 Mobile Support - Designed with a mobile-first mindset
• 🏁 Every WCA Event - Play every officially supported WCA event type
• 💬 Chat - Built in text chat support
• 🖥️ Open Source - Work to improve the project with the community!

Project Structure

• api/: The REST API responsible for handling interactions with the database, user authentication, and abstracting web socket brokerage from the client. This is a simple express application.
• web/: The front end part of the application. This runs with React using Nextjs.
• ws/: This is where WebSockets are created and managed.

Development

Node.js & Yarn

Firstly, install Node.js. This is needed to install the packages for the services, all of which run with Node.js. Once you've installed Node.js, enable Yarn.

Docker

Secondly, install Docker. This makes it very easy to locally run the entire stack for local development and testing. Once you've installed Docker, run the following from the command line:

$ docker compose up

This should start every part of the stack as well as a couple of utility services. Open a web browser and navigate to http://localhost:3000 and make sure that the landing page loads up.

Frontend Pages

• Frontend - http://localhost:3000
• PostgresSQL Admin Panel - http://localhost:8910
• Mailhog - http://localhost:8025