Deployment

Please note that this page is for developers and system administrators, and likely does not contain any information relevant to users of MicrobeTrace.

MicrobeTrace is designed to be an easy-to-deploy, client-side application. However, most of MicrobeTrace's dependencies are served directly out of its node_modules directory, so you'll need to populate that in order to generate a working deployment.

# 1. Clone MicrobeTrace

git clone https://github.com/AABoyles/WebMicrobeTrace.git && cd WebMicrobeTrace

# 2. Download Dependencies

npm install

If npm returned successfully, then MicrobeTrace is ready to be served. If you already have a fileserver set up, you need only copy (or link) the MicrobeTrace files to the server's directory. If you don't, you can launch MicrobeTrace's barebones server like so:

npm start

You should now be able to access your MicrobeTrace instance by visiting http://localhost:5000/

Deploying to Heroku

The public instance of MicrobeTrace is currently served from Heroku, following the master branch of the repository. If you'd like to mirror this architecture for your own instance of MicrobeTrace, simply:

1. Fork this Repository.
2. Create a new Heroku App.
3. Point the Heroku app to your fork of the MicrobeTrace Repo.
4. Set Heroku to update automatically whenever whateveryourbranchis is updated.

And you're done. Good job!

Deploying to S3

Deploying to S3 is a pain in the neck if you don't have the AWSCLI installed, so do us all a favor and get that set up first. Also, create a bucket from which to serve the files. Then, from the MicrobeTrace directory,

aws s3 cp s3://<your-bucket>/ * -R

As soon as the upload is complete, your MicrobeTrace instance should be available at http://<your-bucket>.s3-website-<AWS-region>.amazonaws.com

Note that this won't update like a heroku deployment will (there is not enough room on this wikipage to explain how to set up that architecture).