Getting Started

This page describes how to setup the project on your computer for local development.

Prerequisites

Setting Up the Project

Note

For Windows users, there (will be) a dedicated quick-start guide.

First, you should create a folder for Bemuse development:

mkdir Bemuse
cd Bemuse

Then, clone the Bemuse repository and music repository:

git clone git@github.com:bemusic/bemuse.git
git clone git@github.com:bemusic/music.git

After these repository has been cloned, cd into the Bemuse repository:

cd bemuse

Install the project’s dependencies:

npm install

When it finishes installing, start the development server:

npm start

The game should be accessible at http://localhost:8080/?mode=app.

To run unit tests, go to http://localhost:8080/?mode=test.

Coverage Mode

We measure the code coverage to make sure that most part of our code is covered by some test. This helps us be more confident in modifying our code.

To turn on the coverage mode, start the server with the BEMUSE_COV environment variable set to true:

BEMUSE_COV=true npm start

Then run the unit tests. After the unit tests are run, the coverage report will be generated. They can be viewed at http://localhost:8080/coverage/.

Building

To build the source code into a static web application, run:

npm run build

The built files will reside in the build directory.

Running Tests from Command Line

You can run tests from the command line by running:

npm test

This will effectively

  1. build Bemuse with coverage mode turned on,
  2. start a web server,
  3. start a web browser and navigate to the test page, effectively running the tests,
  4. collect the results and code coverage and write reports.