A live version of this site can be found online at https://blockstack.org.

git clone --recursive [email protected]:blockstack/blockstack.org.git
npm install

Clone this repo locally, then run npm install from the root directory.

npm run dev

To run the site in development mode, run npm run dev (this may require installing Gulp globally npm install gulp -g). Your browser will automatically be opened and directed to the browser-sync proxy address.

Now that npm run dev is running, the server is up as well and serving files from the /build directory. Any changes in the /app directory will be automatically processed by Gulp and the changes will be injected to any open browsers pointed at the proxy address.

This repo uses Git Submodules for documentation and links to the blockstack repo. Everytime you start up the server, new changes will be pulled automatically from the github.com/blockstack/blockstack repo. You can force this update with the following:

npm run fetch-docs

For simplicity, please make any edits to the .md files directly in the /blockstack/blockstack repo instead of the document in the included submodule.

Periodically you may need to update to the latest version of Blockstack's Bootstrap fork.

Install the latest version of blockstack-bootstrap by running the following:

npm install bootstrap

If you'd like to update the UI framework for Blockstack, you can do so by visiting the Blockstack Bootstrap repo and submitting pull requests there.

Note: when you submit pull requests from your fork, make sure you select blockstack/blockstack-bootstrap as the base fork.

npm run prod
firebase deploy

To prepare assets for production, run gulp prod. This will fill the /build directory with the full site.

Note: the production task does not fire up the browser-sync server and won't provide you with browser-sync's live reloading. Simply use gulp dev during development to utilize this functionality.

Once the build has been produced, deploy the site to firebase by running firebase deploy.

• ReactJS (along with React Router and RefluxJS)
• SASS
• Gulp (using best practices from Gulp Starter)
• Browserify

For more in-depth information on any of the steps or libraries use, see the development guide:

Development Guide