Development Guide

Building a Jekyll Site

This site is implemented in Jekyll, thus requiring Ruby and Node.js. We also use Python in our automation and testing.

Please remember not to attempt to integrate your project site with our build process. It will be much simpler to submit a static set of pages that can be served from your assigned directory. You may nevertheless find it helpful to build our site as part of confirming that your file integrate correctly.

Installing Node.js, Python, Ruby, and Ruby DevKit

We currently use:

Creating a Virtual Environment and Installing Dependencies

All Python work should be done within a virtual environment, to avoid dependency conflicts. Node.js and Ruby have their own dependency management (i.e., npm shrinkwrap and bundler). Our Python automation scripts will employ those tools, but we first need to configure Python.

Create the virtual environment. From the working directory of our project (e.g., c:\devel\web-cse440-sp16\):

c:\Python35\python.exe -m venv env35    

This will create a directory for the virtual environment (e.g., c:\devel\web-cse440-sp16\env35\).

Next activate that virtual environment and install our Python dependencies:

env35\Scripts\activate.bat
pip install -r requirements3.txt

Next use Python’s invoke automation to get the rest of our dependencies:

invoke update_dependencies

Building and Serving the Site

Invoke automation is provided for building the site.

If it is not already active, you need to re-activate the virtual environment. From the working directory of our project (e.g., c:\devel\web-cse440-sp16\):

env35\Scripts\activate.bat

To build the site:

invoke build_test

To build and serve the site on localhost:4000, continuously updating based on changes:

invoke serve_test

Submitting Changes via Pull Request

This course website lives on GitHub:

https://github.com/uwcse440/web-cse440-sp16

We recommend the GitHub Desktop client:

https://desktop.github.com/

You can submit pull requests, and should be certain you submit them via feature branches:

https://guides.github.com/introduction/flow/

https://www.atlassian.com/git/tutorials/comparing-workflows

https://spring.io/blog/2010/12/21/social-coding-in-spring-projects

http://codeinthehole.com/writing/pull-requests-and-other-good-practices-for-teams-using-github/