Skip to content

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

CubeMaster

A Rubik's Cube companion app combining three modes: Solver (input cube state, get step-by-step solution), Coach (learn solving methods from beginner to advanced), and Timer (speedcube timer with scrambles and stats).

Tech Stack

Layer Technology
Runtime Bun
Monorepo Turborepo
Build Vite
Server Hono
UI React 19
Styling Tailwind CSS v4
UI Components Radix UI + daisyUI
State Management Nanostores
Testing Bun test
Language TypeScript (strict)

See docs/architecture.md for detailed rationale.

Prerequisites

  • Bun >=1.2.0
  • Git

Getting Started

bun install
bun run dev

Project Structure

apps/
  web/                    Hono server + React UI
packages/
  cube-engine/            Pure TypeScript Rubik's Cube 3x3 engine
  eslint-config/          Shared ESLint configuration
  ts-config/              Shared TypeScript configuration
docs/
  product.md              The three modes (Solver, Coach, Timer)
  architecture.md         Stack, monorepo layout, dependency boundaries
  frontend.md             Design system and UI conventions
  git-workflow.md         Branching, commits, PRs
  adr/                    Architecture decision records

Scripts

bun run dev              # Start all apps in development mode
bun run build            # Build all applications
bun run test             # Run all tests
bun run typecheck        # Type check all TypeScript
bun run lint:check       # Lint check
bun run format:check     # Format check
bun run clean            # Clean build artifacts
bun run reset            # Clean and reinstall dependencies

Start with AGENTS.md — the operating map for the repo.

Documentation

License

MIT

Author

Titux Metal

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages