Skip to content
This repository has been archived by the owner on Sep 28, 2023. It is now read-only.

Latest commit

 

History

History
97 lines (72 loc) · 3.05 KB

README.md

File metadata and controls

97 lines (72 loc) · 3.05 KB
Raw

GOV.UK Mockup Kit

A screenshot of the service home page

A website builder that uses the GOV.UK Design System.

The design is derivative of (N.B.: stolen from) GOV.UK Forms.

Hosted

main branch: https://govuk-mockup-kit.fly.dev/ (username/password: mockup/kit)

Previous versions:

Branch Design history post URL (Heroku might take a while to spin up)
mvp 22/05 – MVP design and build https://govuk-mockup-kit-mvp.herokuapp.com/ (mockup/kit)

What is this

The user need:

As a... person working on a government service
I need to... create a prototype without having to write code
So that... I can share it with colleagues or use it in research

The hypothesised solution (MVP):

A website builder interface, that does not require technical knowledge to use, that allows the user to create pages and fill them with components from the GOV.UK Design System. The user can tweak content, change ordering of pages, and preview what their finished prototype will look like. At the end, they can export it as a prepopulated govuk-prototype-rig project.

This project will probably never be finished (maybe it isn't worth building?), but like most things I work on and never finish I pushed it up to GitHub anyway. If it sounds cool to you too feel free to reach out and chat to me about it.

Roadmap

  • 💥 Creating journeys
  • 📑 Adding pages
  • 🕵️ Previewing
  • 📠 Export to prototype kit
  • 🕴️ Login with GitHub
  • ⛴️ Import an existing prototype
  • 💻 Editing pages in code
  • 🔄 Syncing with a prototype
  • 🧾 Check your answers
  • 🏁 Customisable end page
  • 📽️ Live preview
  • ♻️ Reordering
  • 🎶 Multiple page types
  • 🏎️ Optional Turbo

Setup

Standard Rails 7 / Ruby 3 project. Example:

asdf install # Install optimal ruby/nodejs/etc versions, see .tool-versions
pg_ctl start # If not already running postgres

bin/setup    # bundle / yarn / database setup
vim .env     # See the OAuth app section below

bin/dev      # Local development on http://localhost:3000
bin/lint     # Run linters
bin/test     # Run all tests

Creating an OAuth App for local development

  1. Go to Github > Settings > Developer settings > OAuth Apps
  2. Click on "New OAuth App"
  3. Set name and URL to anything
  4. Set "Authorization callback URL" to http://localhost:3000/users/auth/github/callback
  5. Regiser application
  6. Generate a secret
  7. Edit .env
# .env
GITHUB_KEY=Replace with the Client ID from your OAuth App
GITHUB_SECRET=Generate a client secret

Licence

GPLv3.