Rubik

---

Getting Started

Clone the repository and install dependencies with npm.

$ git clone https://github.com/kostkobv/rubik.git
$ cd rubik
$ npm install

Building

The build script defined in the package.json file uses webpack to transpile sources in the src and test directories. The successfully transpiled sources are placed in the build folder. This folder is preserved by npm, but ignored by git.

$ npm run build

The pretest, prestart, and prepublish scripts defined in the package.json file all reference the build script, so there's no need to run the build script manually in those situations.

Testing

Test the project with npm test.

$ npm test

Again, this will automatically run the build script first.

Publishing

Publish the project on the local machine (for testing) with npm install.

$ npm install -g ./
$ rubik

In both cases, again, this will automatically run the build script first.