Git Product home page Git Product logo

prototyping's Introduction

Prototyping

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.

How to make a new prototype and configuration

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!

Starting the app

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!

Prerequisites & installation

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:

  1. After installing git and creating github account http://help.github.com/mac-set-up-git/

  2. 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

  3. then run sudo gem install jekyll (see https://github.com/mojombo/jekyll/wiki/install )

  4. then finally git clone [email protected]:alphagov/prototyping.git prototyping to get a copy of the prototyping tool.

Pushing online

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:

  1. Sign up to Heroku

  2. Get invited into our Heroku instance as a contributor

  3. Install the Heroku toolbelt from https://toolbelt.herokuapp.com/

  4. 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
  
  1. 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

  2. You can confirm this has worked by using "git remote" then checking you see:

  origin
  heroku
  
  1. Then every time you updated and committed your latest work, you can push to Heroku with "git push heroku master"

  2. 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.

prototyping's People

Contributors

phae avatar futurefabric avatar timpaul avatar alextea avatar antimega avatar markhurrell avatar garethr avatar bradwright avatar

Stargazers

Alice Newton avatar

Watchers

James Cloos avatar Alice Newton avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.