Quickstart for Windows - vizabi/vizabi GitHub Wiki

Note: This guide explains how you set up your environment to develop Vizabi. If you just want to use Vizabi, skip this chapter and move on

####Cloning In order to run vizabi locally, clone it:

git clone https://github.com/vizabi/vizabi
cd vizabi

You can alternatively install GitHub client for Windows or for Mac. Then return to Vizabi page on Github and press Clone in desktop button to the left. The installed GitHub client should ask you where to put the files and then automatically proceed with cloning:

####System requirements:

• All dependencies together take around 500 MB of disk space plus Vizabi itself is ~200 MB.
• Windows/Mac/Linux

####Dependencies Vizabi depends on node.js + npm

Node is a platform for building network applications. Install it first. When done you will be able to use the included Node Package Manager (npm) to install dependencies. You can verify the installation by opening command prompt (in any folder) and checking the version, like this:

####Setting up Now that you have all the dependencies in place, you can set up Vizabi. Go to Vizabi directory, where you have cloned it earlier, and run the following commands in the terminal:

npm install

Note: You may need admin rights (restart command prompt as an administrator).

####Running and Developing We use webpack to build Vizabi. In order to run the project locally in development mode, go to Vizabi folder in your command prompt and type the following:

npm start

Open the example pages in your browser at http://localhost:8080/preview/, and you should be able to see the list of vizabi examples.

In order to build the project for production and distribution, type the following:

npm run build:prod

You can find the build output under build/.