CubeIndex

CubeIndex is a web app for speedcubers to track, explore, and manage their cube collections. Whether you're into speedcubes or collectibles, CubeIndex helps you organize and showcase your cubes with ease.

CubeIndex is set to release in August 2025. We are currently in the beta stage of development, which you can try out here: cubeindexbeta.netlify.app

🧠 Tech Stack

• Frontend: SvelteKit, Tailwind CSS
• Backend: Supabase (PostgreSQL)
• Auth: Custom session-based authentication
• Tooling: TypeScript, ESLint, Vitest, Vite

🗂 Project Structure

• src/routes/ – Pages and endpoints
• src/lib/components/ – UI components

🚀 Deployment

• Main Branch (Production): cubeindex.netlify.app
• Developer Branch (Beta Preview): cubeindexbeta.netlify.app

🛠 Setup Instructions

1. Clone the Repo

   git clone https://github.com/cubeindex-project/CubeIndex.git
   cd CubeIndex
   

2. Install Dependencies

   npm install
   

3. Configure Environment

   cp .env.example .env
   

4. Set Up Database with Supabse CLI

Only do this if you plan on working on stuff related to the database. It is quite heavy and needs Docker to be installed and running. More Info

npx supabase run
npx supabase db reset

6. Start the Dev Server

   npm run dev
   

Visit http://localhost:5173

🤝 Contributing

We welcome contributions! Here's how to get started:

• Fork & branch off developer
• Use clear names like feat/add-cube-model
• Follow code style (TypeScript, ESLint)
• Commit clearly (e.g. fix: login bug)
• Open a PR with description and context
• Reference issues when applicable (e.g. Closes #12)
• Chat with us on Discord for guidance

🧩 Contribution Example

git checkout -b feat/my-feature
# Make your changes
git commit -m "feat: add new feature"
git push origin feat/my-feature

Then open a Pull Request to developer on GitHub.

👥 Community & Support

• Join us on Discord
• Create issues for bugs or feature ideas

📦 Miscellaneous

• ⭐ Star History:
  

📄 License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.

Thanks for helping build CubeIndex! 🧊