Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.42 KB

deploying.md

File metadata and controls

39 lines (27 loc) · 1.42 KB

To Github pages

If your Chartbuilder is on a Github repo, you can deploy it to github pages using the command:

	npm run gh-pages

The resulting page will also contain the Chartbuilder API docs at /api-docs, with Chartbuilder at the root index.html.

Deploying your Chartbuilder

Once you're done customizing, you'll want to build the source files so that you can upload them to your hosted location.

Deployment is easy! Just do:

	npm run build

This will use gulp to concatenate and minify your javascript. (The javascript you get from npm run dev is not minified, if you need to check what that looks like.) The build task will also convert all of the fonts defined in your CSS base64, which makes image export more robust.

Once that completes, the finished product will live in the build folder inside of your project directory. You can just move the contents of build to a server using FTP or however else. Or you might create a simple auto-deploy script like so:

	#!/bin/sh
	echo "BUILDING CHARTBUILDER..."
	npm run build
	echo "SYNCING BUILD WITH REMOTE FILES..."
	rsync -rav --progress build/* <MY_SERVER_LOCATION>

AWS

Chartbuilder can easily be automatically deployed to Amazon Web Services. Just rename the file at gulp/aws-config.json.example to gulp/aws-config.json, and add your credentials. Then you can run the npm run aws process to deploy.