First things first, there's always something before you can start.

To make our life easier, we use NPM a lot. Make sure you have it installed.

Our application runs in Docker. If you don't already use it, now would be the time. Make sure the Docker daemon is up and running.

We store our data in Azure Storage, so you need to be able to do so as well. On Windows, you can use the Azure Storage Emulator. For Mac users, we recommend creating a free Azure account.

Register a new OAuth application. This will allow users to connect to their GitHub account.

Make sure you set the Authorization callback URL to http://localhost:1337/auth/github/callback (you can also use your preferred port).

Building the application is easy. First run npm install && npm run build, to build the application.

If you run into problems with building using npm, this is likely caused by our use of lerna combined with some of the latest node features. A solution is to only use the npm install and build command in the packages/website-frontend directory.

Next, you need to define the following environment variables in a Docker enviroment variables file:

You can also enter these in the commandline, but we recommend using a separate file because it contains sensitive information.

To start the application, you can now simply run docker run --env-file env.list -p 1337:1337 strykermutator/dashboard. This will spin-up a Docker container with the image that was build earlier; provide it with your environment variables set in the env-list file; and open port 1337 so you can access it on your local machine.

Stryker Dashboard should now be available at http://localhost:1337.

Building and re-running the Docker image everytime you make a small front-end change is a bit too much work. We use a proxy config file packages/website-frontend/proxy.config.json, to redirect requests from the frontend running locally (served by running npm start) to the backend running in a Docker container.

Pull requests are welcome! See the list of open issues to get an idea of what you could work on. Or, if you have an awesome idea, please create a new issue or discuss it on Gitter.