Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 2.37 KB

README.md

File metadata and controls

74 lines (51 loc) · 2.37 KB

Promotional Image

Rubik's Cube Timer

Dependency Status devDependency Status

The Rubik's Cube Timer allows you to record and manage your cube records. It's features and design is strongly influenced by Cube Timer, but uses a more modern design.

The Rubik's Cube Timer chrome app allows you to install and use the timer locally.

Screenshot

Development

Cube Timer uses Grunt as build system, which must be installed using npm. Node.js packages the command npm, so it needs to be installed as well. On Mac you could use Homebrew to do that.

brew install nodejs
npm install -g grunt grunt-cli

As soon as grunt is available as command the build can be initialised.

npm install

Building

The dist task creates a distribution directory dist which contains the entry point index.html and all relevant resources. The dist directory can also be used as the Apache DocumentRoot.

grunt dist

Watching

Any change within the src directory must be followed by a grunt dist to reflect the changes into the dist directory. To avoid doing this manually, Grunt offers the watch task: it watches a set of files for changes and invokes the given tasks after a change has been identified.

grunt watch

Packaging

The dist task creates a zip file in the dist directory. That file can then be published in the chrome web store.

grunt dist

Caveats

The Google API only works when the app is delivered from http://localhost/. To use it, use a webserver that delivers the content of the dist/cube-timer directory.

Sources