2.2 KiB
Requirements
python 2.7.x
# npm install -g less
# 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 (and the submodules)
git clone --recursive git@github.com:NUKnightLab/TimelineJS.git
# Change into the timeline repository
cd TimelineJS
# Create a virtual environment
mkvirtualenv TimelineJS
# Activate the virtual environment
workon TimelineJS
# Install python requirements
pip install -r requirements.txt
# Run the development server.
fab serve
# Re-compile to preview changes. Of course this will need to be in another terminal, or after the fab serve command was put in the
# background. It would be great to automate this, but we would like to not add another build system and haven't figured out how to
# do it with fabric. Pull requests are welcome!
fab build
Overview
Files in the source 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 (timeline.knightlab.com)
To deploy to S3, type fab deploy.