cube.zone

Cube.Zone is a social cubing platform where cubers can race and interact with each other in real time. This is the source code of the Cube.Zone front end web application, distributed under the MIT License. The current production version of the application can be viewed at https://cube.zone.

The Cube.Zone frontend uses the proprietary Kubeverse backend graphql API and the Pusher web socket service for transmitting live data. Example credentials and endpoints are available in this package for contributors to use.

Getting Started

Create your .env file, and copy over the contents of .env.example. You can leave the credentials as they are for the example credentials, or you can replace them with your own.

# install dependencies
$ npm install

# serve with hot reload at localhost:3000
$ npm run dev

# generate static project
$ npm run generate

Static code analysis

The project is linted with Eslint and formatted with Prettier.

A pre-commit hooks checks that both linting and format validation pass (run npm run validate to check locally).

The following scripts are available:

# check linting issues
$ npm run lint

# check and fix linting issues
$ npm run lint --fix

# check code formatting
$ npm run check-format

# format code
$ npm run format

# validate code formatting and linting
$ npm run validate