Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 1.43 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] (http://git-scm.com/), Npm, Gulp Sass, and SCSS Lint.

Installation Requirements For Mac Users

  1. Install git http://git-scm.com/download/mac
  2. Install nodejs https://nodejs.org/en/
  3. Install Gulp npm install --global gulp (run with sudo if needed)
  4. Install sass gem install sass (run with sudo if needed)
  5. Install scss_lint gem install scss_lint (run with sudo if needed)

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:

gulp

The browser will open on http://localhost:8080/preview/

In order to only build the project, type the following (you'll rarely need this):

gulp build

You can find the build output under build/ folder.