Skip to content

Nexus Timer is a powerful unopinionated, minimalist training tool for SpeedCubing.

License

Notifications You must be signed in to change notification settings

Ganesh107/NexusTimer

 
 

Repository files navigation

About The Project

For those new to speedcubing, it's a puzzle-solving challenge where cubers aim to solve the Rubik's Cube as quickly as possible. The objective is to align all the cube's colors correctly while racing against the clock for the fastest solve time. Achieving a fast solve time is the goal.

Speedcubing preview

rainbow

Preview

preview
Fast, unopinionated, minimalist web tool for SpeedCubing
JS badge TS badge TAILWIND badge REACT badge NEXT badge

Overview

This timer is carefully designed to keep track of solving times, giving valuable information and making the speedcubing experience even better. It's an essential tool for speedcubers who appreciate quality. rainbow

What's the difference?

Cool Stats

We like to find interesting data about you by extracting meaning from your training sessions, not like a conventional timer. This process often unveils insights you may not have even been aware of.

Metrics by cube or method

We have included what I called the "Category Aggregation Principle." To empower speedcubers to compute and analyze statistics not just for individual categories but also for each individual cube within the same category without affect or modify overall calculations.

No DNF

Who likes? We won't cover calculations using DNF, instead delete the solve or add you a +2 penalty.

Portability

While our primary focus is on delivering an optimal experience for desktop training, we are actively striving to extend this functionality to cater to the needs of mobile users.

Modern design

Our UI is heavily inspired by Twisty Timer, the ultimate timer on mobile category. However, we've added more features, with even more on the way.

This is what makes unique and versatile Nexus Timer.

rainbow

Getting Started

Prerequisites

  • Node & NPM Installed

Installation of NexusTimer

  1. Clone the repo
    git clone https://github.com/bryanlundberg/NexusTimer.git
  2. Install NPM packages
    npm install
  3. Run a script available (npm run dev - npm run build - npm run start)
    npm run dev
    rainbow

Roadmap

  • WCA
    • Include optional 15s inspection
    • Add voice alerts for inspection
    • Handle penalties exceeding inspection time
  • Localization and Accessibility
    • Enhance and expand translations
    • Sounds for application
  • Animations
    • Opening and closing modals (Fade in, out)
    • Opening and closing menu-settings (smooth scroll left to right)
    • Loading screen effect, only first time
  • Cloud support (Backend)
    • Move from localStorage to server storage

See the open issues for a full list of proposed features (and known issues). rainbow

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

About

Nexus Timer is a powerful unopinionated, minimalist training tool for SpeedCubing.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 94.1%
  • JavaScript 5.7%
  • CSS 0.2%