Installing

Building from source

Ensure you have Node.js (>6.0) installed.

Then obtain a copy of the source by either downloading the zipball or cloning the public repository:

git clone https://github.com/buddly27/sudoku-javascript.git
cd sudoku-javascript

Install dependencies using NPM:

npm install

Build a production ready version of the application:

npm run build

Deploy the built files behind a web-server.

Building documentation from source

Documentation is built using Sphinx which runs under Python.

Ensure you have installed the ‘extra’ packages required for building the documentation:

pip install .

Then you can build the documentation with the command:

python setup.py build_sphinx

View the result in a browser at:

file:///path/to/sudoku-javascript/build/doc/html/index.html

Running tests against the source

With a copy of the source it is also possible to run the unit tests:

npm test

Ensure that the code linting is correct with the following command:

npm run lint