git-jekyll-preview

git-jekyll-preview

Preview your Github-hosted websites before making them live.

Git-Jekyll Preview

Preview your Github-hosted websites before making them live. Use it to check your plain static or Jekyll-generated websites before you make them live to Github Pages or to your own server.

Try it live at jekit.codeforamerica.org.

Status, Contact

Git-Jekyll Preview is mostly a singleton-app, built only to be run at a single location. For the time being, it's not intended for general redeployment but improvements for jekit.codeforamerica.org are welcomed.

Michal Migurski is currently maintainer.

Install

Git-Jekyll Preview is intended to be run on its own Ubuntu server, and will not currently work on a managed system like Heroku. Installation dependencies are managed by Chef. It should be possible to install Chef and run all required recipes with the script install.sh. Note the world-writeable directories created in chef/directories.

The application is a Flask-based Python server which shells out to Git for interaction with Github. OAuth is used for authentication; put your client ID and secret in git.py.

To run for testing:

python make-it-so.py

To run in production, with Gunicorn:

gunicorn make-it-so:app