Skip to content

cubecult/rcubed

Repository files navigation

RCUBED

rcubed codecov

A new cubing application made by some good old cubing friends.

The core cube library utilizes the mathematical permutation group as found on Ruwix1.

Getting Started

These instructions should get you up and running on base React app.

Prerequisites

Our dependencies are managed through Yarn.

If on a Mac, install via Homebrew:

brew install yarn

Otherwise, follow the installation instruction on the Yarn website.

Installation

Once Yarn is installed, you can install all the required dependencies:

yarn install

Running The App

To start the app:

yarn start

Running Tests

Tests will by default run with code coverage. To run tests:

yarn test

1 Cube representation (subtract 1 from all numbers): https://ruwix.com/pics/rubiks-cube/mathematics-permutation-group.jpg