imaadzaffar / cubyl-timer

Web app for generating Rubik's cube scrambles and timing solves

Cubyl Timer

Web app for generating Rubik's cube scrambles and timing solves

Live Website · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact
6. Acknowledgements

About The Project

Add about text

Built With

• Scrambo

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/zafaris/cubyl-timer.git

2. Install NPM packages

   npm install

Usage

To start the timer, you can either click on the main button, or you can hold the spacebar down for 300ms. Once the timer has started, click on the button to stop the timer, or you can just press the spacebar. Once the timer has stopped, to reset the timer and generate a new random scramble, either click on the main button again, or press the spacebar again. Now go set some PBs!

License

Distributed under the MIT License. See LICENSE.md for more information.

Contact

Imaad Zaffar · YouTube · Instagram · Twitter · LinkedIn · Email

Project Link: https://github.com/zafaris/cubyl-timer

Acknowledgements

• Rubik's Cube icon icon by Icons8