archivist

Install

Put .env file with credentials

MONGO_URL=***
RS_NAME=***

Install Heroku Toolbelt. Then pull in npm and Substance modules

$ npm install

Now you can run the server

npm run devmode

It'll start server app and recompile js bundle when you change source of platform app

For starting server without watch mode use

npm run start

You could also prepare compress bundle (js&css) without starting server, use

npm run prepare

Development

If you want to make changes in some of the modules you need to check them out with git instead of npm and use npm link. Do this:

$ mkdir archivist-project
$ cd archivist-project

$ git clone https://github.com/substance/archivist.git
$ git clone https://github.com/substance/archivist-composer.git
$ git clone https://github.com/substance/substance.git
$ cd archivist
$ npm install

Now npm link stuff:

$ cd ..
$ cd ../substance
$ sudo npm link
$ cd archivist-composer
$ sudo npm link
$ npm link substance
$ cd ../archivist
$ npm link archivist-composer

To make use of the Substance Sublime helpers, make a Sublime project and add all three folders to it. Then you can press ctrl+shift+s to bring up a nice git status dialog.

Rebundling of the composer happens automatically when you do npm install. For manual rebundling do:

$ gulp bundle-composer

Deploy

$ git checkout release

$ git merge master

There might be conflicts, merge carefully. We will try to achieve a setup where the assets are the only difference.

$ substance --bundle

Commit all changes.

$ git push heroku release:master

Try everything out. If something is obviously broken you can fix it and try again.

$ git push origin release