{"_id":"5455828da1e5cd0e00435ee9","version":{"_id":"5452b671b7fa011600a75c25","__v":13,"forked_from":"545285163f92fc0e009396ca","project":"545285163f92fc0e009396c7","createdAt":"2014-10-30T22:06:41.529Z","releaseDate":"2014-10-30T22:06:41.529Z","categories":["5452b671b7fa011600a75c26","545579ee35f4ac0800f42bac","54557a3135f4ac0800f42bad","54557b7b35f4ac0800f42bb3","54557c91a1e5cd0e00435ecc","54557caf35f4ac0800f42bbd","54557dc1a1e5cd0e00435ecf","54557e7ba1e5cd0e00435ed6","54557f81533d890e000cf8a9","54557fcd533d890e000cf8aa","54558020a1e5cd0e00435edf","545580b6533d890e000cf8ad","545580e1a1e5cd0e00435ee6"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.2.0","version":"0.2.0"},"__v":10,"category":{"_id":"54557c91a1e5cd0e00435ecc","__v":5,"pages":["54558241a1e5cd0e00435ee7","5455828da1e5cd0e00435ee9","54558344a1e5cd0e00435eec","545583a1533d890e000cf8b9","545583e0a1e5cd0e00435ef2"],"version":"5452b671b7fa011600a75c25","project":"545285163f92fc0e009396c7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-02T00:36:33.382Z","from_sync":false,"order":0,"slug":"guides","title":"Guides"},"is_link":false,"project":"545285163f92fc0e009396c7","user":"545284e73f92fc0e009396c6","updates":["54573cdb1f26430800ae067f"],"next":{"pages":[],"description":""},"createdAt":"2014-11-02T01:02:05.300Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"results":{"codes":[]},"try":true,"auth":"never","params":[],"url":""},"isReference":false,"order":1,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Required files\",\n  \"body\": \"For ViziCities to work you need to include the `vizi.min.js` JavaScript file as well as the `vizi.css` file within your HTML. It's up to you whether you want to use minified files or not (it's recommended you do).\\n\\nIf you plan to use Web Workers (some Blueprint modules require it) then make sure you have the `vizi-worker.min.js` file in the same directory as your HTML file. Otherwise, you can [specify a `workerURL` option](https://github.com/vizicities/vizicities/blob/0.2.0/examples/basic-example/main.js#L101) for the relevant Blueprint module.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Using Bower\"\n}\n[/block]\nThe simplest way to install ViziCities is to use Bower, a package manager for front-end code. Once you've [installed Bower](http://bower.io) on your machine all you need to do is run the following command in your terminal from within the directory you want to use ViziCities in:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ bower install -p vizicities\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nAfter running this you'll see a `bower_components` directory, which will itself contain a `vizicities` directory that holds the JavaScript and CSS files needed to get up and running.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Using the CDN\"\n}\n[/block]\nIn the near future you'll be able to retrieve and use the ViziCities files directly from a CDN. This section will be updated with instructions as soon as that happens.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Manual installation\"\n}\n[/block]\nIf you want a bit more control over where the files go and how you use them, you'll probably want to do things manually. That's fine and you can get the files you need from the [`build` directory](https://github.com/vizicities/vizicities/tree/0.2.0/build) on the ViziCities GitHub repository.","excerpt":"","slug":"installing-vizicities","type":"basic","title":"Installing ViziCities"}

Installing ViziCities


[block:callout] { "type": "info", "title": "Required files", "body": "For ViziCities to work you need to include the `vizi.min.js` JavaScript file as well as the `vizi.css` file within your HTML. It's up to you whether you want to use minified files or not (it's recommended you do).\n\nIf you plan to use Web Workers (some Blueprint modules require it) then make sure you have the `vizi-worker.min.js` file in the same directory as your HTML file. Otherwise, you can [specify a `workerURL` option](https://github.com/vizicities/vizicities/blob/0.2.0/examples/basic-example/main.js#L101) for the relevant Blueprint module." } [/block] [block:api-header] { "type": "basic", "title": "Using Bower" } [/block] The simplest way to install ViziCities is to use Bower, a package manager for front-end code. Once you've [installed Bower](http://bower.io) on your machine all you need to do is run the following command in your terminal from within the directory you want to use ViziCities in: [block:code] { "codes": [ { "code": "$ bower install -p vizicities", "language": "text" } ] } [/block] After running this you'll see a `bower_components` directory, which will itself contain a `vizicities` directory that holds the JavaScript and CSS files needed to get up and running. [block:api-header] { "type": "basic", "title": "Using the CDN" } [/block] In the near future you'll be able to retrieve and use the ViziCities files directly from a CDN. This section will be updated with instructions as soon as that happens. [block:api-header] { "type": "basic", "title": "Manual installation" } [/block] If you want a bit more control over where the files go and how you use them, you'll probably want to do things manually. That's fine and you can get the files you need from the [`build` directory](https://github.com/vizicities/vizicities/tree/0.2.0/build) on the ViziCities GitHub repository.