franklin-build

README

Franklin Build

Contributing

Two things to note about contributing to this project:

1. Follow common Go best-practices as presented in the fantastic Effective Go document.
2. Use gofmt before committing any code

Getting Started

Since this project is very lightweight and requires building docker images, we are NOT currently run it using docker to avoid "Docker in Docker" (DinD) for the moment. This will likely change in the future as the need arises.

• Install docker toolbox

• Install Go and set up your GOPATH

To install, run go get in your go path: go get github.com/istrategylabs/franklin-build

This will install all packages and dependencies

To install and compile manually use the following steps:

1. git clone https://github.com/istrategylabs/franklin-build/
2. go get
3. cd franklin-build
4. make build

Environment Variables

The following environment variables will need to be set:

BUILD_LOCATION
ENV
DEPLOY_ROOT_FOLDER
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_BUCKET

1. Set the BUILD_LOCATION environment variable (location where project will build to): export BUILD_LOCATION=<location>
2. Set the ENV environment variable (production or test): export ENV=test
3. Set the DEPLOY_ROOT_FOLDER variable to the folder where successfully build projects will be rsync'd to. Nginx in franklin will have the same exact setting. export DEPLOY_ROOT_FOLDER=/var/www/franklin/
4. Local dev only. Used to send built files to Amazon S3
5. Local dev only.
6. The name of the bucket on S3 to send the files to

Running

1. make run
2. Make a POST request to localhost:3000/build with a body similar to what is found in test/sample_data.json
3. You can run the test suite by running make test

Deployment

All you need to do to deploy (if your keys are on the server) is run fab {{ environment }} deploy