Use this app to make your protype static apps in!
It uses jekyll - https://github.com/mojombo/jekyll - to generate static files generated from templates.
Just create a new folder, named eg "app-name", then duplicate the root index.html into it.
Configuration is easy, here's the only bit you need to edit:
--- layout: default title: Prototype app categories: Format ---
Set "layout" to the template file you want to use - the current one "default" is just the header and footer from gov.uk. It currently pulls in CSS from the gov.uk CDN. So you can probably leave this alone.
Set "title" to the name of the app you are building - it controls what appears as the main page title.
Set "categories" to be whatever the gov.uk format might be - eg "service".
Then underneath just start shoving in the content of the prototype!
Just type "jekyll --server" at the command line in the root folder. (add "&" at the end if you don't want to lock up your command line and are happy killing processes)
Then in your browser navigate to http://localhost:4000/[app-name]/index.html
Bosh!
Needs Ruby 1.9.x (not installed by default on OS X 10.7, but GDS dev build includes it) & jekyll
Follow this process to get up to speed:
-
After installing git and creating github account http://help.github.com/mac-set-up-git/
-
Update Ruby, easiest way was to follow the "Install Ruby 1.9" instructions on http://pragmaticstudio.com/blog/2010/9/23/install-rails-ruby-mac
-
then run sudo gem install jekyll (see https://github.com/mojombo/jekyll/wiki/install )
-
then finally git clone [email protected]:alphagov/prototyping.git prototyping to get a copy of the prototyping tool.
We have an instance of Heroku (http://www.heroku.com/) that you can push the prototyping app to, in order to share prototypes externally. It lives at http://govuk-prototyping.herokuapp.com
So you can push to Heroku from your own machine follow these steps:
-
Sign up to Heroku
-
Get invited into our Heroku instance as a contributor
-
Install the Heroku toolbelt from https://toolbelt.herokuapp.com/
-
At the command line:
$ heroku login Enter your Heroku credentials. Email: [email protected] Password: Could not find an existing public key. Would you like to generate one? [Yn] Generating new SSH public key. Uploading ssh public key /Users/adam/.ssh/id_rsa.pub
-
Make sure you're in the repository, then enter "git remote add heroku [email protected]:govuk-prototyping.git", which adds the Heroku instance as a remote server for the repo, so you can push to it
-
You can confirm this has worked by using "git remote" then checking you see:
origin heroku
-
Then every time you updated and committed your latest work, you can push to Heroku with "git push heroku master"
-
Finally, you can visit eg http://govuk-prototyping.herokuapp.com/licence-format/ to see your prototype
We might want to think about putting on a password at some point.