DEVELOPER.md

Requirements

python 2.7.x

virtualenvwrapper

Node.js

LESS

# npm install -g less

UglifyJS

# npm install -g uglify-js@1

Setup

# Change into the parent directory containing your repositories
cd path_to_repos_root

# Clone the secrets repository (if necessary)
git clone git@github.com:NUKnightLab/secrets.git

# Clone the cdn repository (if necessary)
git clone git@github.com:NUKnightLab/cdn.knightlab.com.git

# Clone the timeline repository
git clone git@github.com:NUKnightLab/soundcite.git

# Change into the soundcite repository
cd soundcite

# Create a virtual environment
mkvirtualenv soundcite

# Activate the virtual environment
workon soundcite

# Install python requirements
pip install -r requirements.txt

# Run the development server
fab serve

Overview

Files in the inner soundcite directory are resources for deployment to the CDN.

Files in the website directory are specific to the website.

config.json is used to control building, staging, and deployment

Deploying to the CDN

To stage your changes to a versioned directory in your local CDN repository, type fab stage This runs a build, copies the files into a versioned directory in your local cdn.knightlab.com repository, and tags the last commit with a version number.

To stage your changes to the latest directory in your local CDN repository, type fab stage_latest This copies files from a versioned directory in your local cdn.knightlab.com respository into the corresponding latest directory.

You must push and deploy all CDN changes separately from that repository.

Deploying to S3 (soundcite.knightlab.com)

To deploy to S3, type fab prd deploy.