Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

52 lines (32 loc) · 1.41 KB
Raw

Gapminder Vizabi

You can contribute to the development of tools or the framework. Read the manual how we collaborate

Cloning the repository

Vizabi depends on Git and Npm.

Installation Requirements For Mac Users

  1. Install git http://git-scm.com/download/mac
  2. Install nodejs https://nodejs.org/en/

Alternative: Install docker

Clone this repo and run the following commands in vizabi root folder:

npm install

If you are still puzzled what it is or it just doesn't work, read a more detailed instruction (it's for Windows, but you'll figure things out if you have a Mac or Linux)

Build the project

In order to run the project in development mode, type the following:

npm start

Open browser on http://localhost:8080/preview/

In order to only build the project, type the following (you'll rarely need this). Build will be created using Docker (Image of Ubuntu 14.04):

npm run build

Build without Docker can be done via:

npm run build:prod

In both cases find the build output under build/ folder.

Note: On Vizabi publishing build will be done using Docker (npm run build).