Git Product home page Git Product logo

cubedeck's Introduction

cubedeck-img

cubedeck

Taking your cubing skills to the moon! ๐Ÿš€๐ŸŒ”

The app is live at cubedeck.netlify.app

About

Cubedeck is a web application that is designed to assist cubers to keep track of their progress by and improve themselves by:

  • helping them easily log their solve times and obtaining stats about their solves
  • creating practice sessions to segregate their solves
  • creating and joining friend groups, to compete for the best solves

Screenshots

session screenshot groups screenshot groups indiv ss home page

Technologies

  • React
  • Next.js
  • ChakraUI
  • TypeScript
  • Firebase (Auth/Firestore)
  • Netlify/Netlify Functions (Hosting)

Project Structure

The code base mainly contains React components in the components directory, and Next.js pages in the pages directory.

Components

Most of the code lies in the components folder in src.

  • groups - Contains components which is involved in managing groups (creating, leaderboard etc.)
  • lpg - Landing page
  • sessions - Contains components involved in managing individual user sessions.
  • solves - Manages solves in a user session
  • std - Standard components like navbar etc.
  • utils - Utility components

Pages

Running Locally

  • Clone the repo
git clone https://github.com/carrotfarmer/cubedeck.git
  • Install all dependencies
yarn
  • Create a firebase project
  • Add your firebase credentials to a .env file like so:

Check out .env.example

NEXT_PUBLIC_API_KEY=
NEXT_PUBLIC_AUTH_DOMAIN=
NEXT_PUBLIC_PROJECT_ID=
NEXT_PUBLIC_STORAGE_BUCKET=
NEXT_PUBLIC_MESSAGING_CENTER_ID=
NEXT_PUBLIC_APP_ID=
  • Run the app
yarn dev

cubedeck's People

Contributors

anishde12020 avatar carrotfarmer avatar dependabot[bot] avatar imgbotapp avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

cubedeck's Issues

Add Timer for Groups

Need to add the same timer functionality for groups as implemented for sessions.

in-app stopwatch

simple in-app stopwatch for timing solves (and a button so that I can record that solve)

what it solves: opening the clock app, clicking the stopwatch tab, pressing start, solving, pressing stop, copying the details, opening cubedeck, navigating to a session, clicking new solve, entering the values, clicking add

P.S - pressing start, solving, pressing stop, opening cubedeck, navigating to a session cant be removed ๐Ÿ˜ญ
P.P.S - ima try pr

Pwa

So that i can install it on my phone instead of going to the site all the time

Will try to chuck in next pwa tmrw

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.