Skip to content
This repository has been archived by the owner on Nov 30, 2021. It is now read-only.

Commit

Permalink
Rework README
Browse files Browse the repository at this point in the history
  • Loading branch information
Demotive committed Jun 3, 2016
1 parent c3d2172 commit b533d93
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 203 deletions.
30 changes: 5 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# NHS.UK Alpha Prototyping Kit
# NHS.UK Alpha Prototypes

This kit is adapted from the [GOV.UK prototyping kit.](https://github.com/alphagov/govuk_prototype_kit).
These prototypes have been built on an adapted [GOV.UK prototyping kit.](https://github.com/alphagov/govuk_prototype_kit).

The kit provides a simple way to make interactive prototypes for NHS.UK alpha. These prototypes can be used to show ideas to people you work with, and to do user research.

It's built on the [Express](http://expressjs.com/) framework and contains code adapted from these GOV.UK resources:
They contain code from these GOV.UK resources:

- [GOV.UK template](https://github.com/alphagov/govuk_template)
- [GOV.UK front end toolkit](https://github.com/alphagov/govuk_frontend_toolkit)
Expand Down Expand Up @@ -41,7 +39,8 @@ git clone https://github.com/nhsalpha/nhs_prototype_kit.git
npm install
```

This will install folders containing programs described by the package.json file to a folder called `node_modules`.
This will install folders containing programs described by the package.json
file to a folder called `node_modules`.

#### Run the app

Expand All @@ -50,22 +49,3 @@ node start.js
```

Go to [localhost:3000](http://localhost:3000) in your browser.

#### Hot reload

Any code changes should update in the browser without you restarting the app.

The app recompiles app/assets/stylesheets/application.scss everytime changes are observed.

## Documentation

Find out how to work with the prototyping application.

* [Getting started](docs/getting-started.md) (Read this first)
* [Creating routes](docs/creating-routes.md)
* [Making pages](docs/making-pages.md)
* [Writing CSS](docs/writing-css.md)
* [Deploying (getting your work online)](docs/deploying.md)

This project is built on top of Express, the idea is that it is straightforward to create simple static pages out of the box. However, you're not limited to that - more dynamic sites can be built with more understanding of Express. Here's a good [Express tutorial.](http://code.tutsplus.com/tutorials/introduction-to-express--net-33367)

47 changes: 0 additions & 47 deletions docs/creating-routes.md

This file was deleted.

64 changes: 0 additions & 64 deletions docs/deploying.md

This file was deleted.

20 changes: 0 additions & 20 deletions docs/getting-started.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/making-pages.md

This file was deleted.

35 changes: 0 additions & 35 deletions docs/writing-css.md

This file was deleted.

0 comments on commit b533d93

Please sign in to comment.