Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Commit

Permalink
More detail in the readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jdbrew committed May 17, 2017
1 parent ceb219f commit 741bcff
Showing 1 changed file with 71 additions and 20 deletions.
91 changes: 71 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,27 @@
Quickly create HTML prototypes of NHS services using the Nightingale framework

# Introduction

The [NHS prototype kit](https://github.com/NHSLeadership/nhs-prototyping-kit/) provides a simple way to make interactive prototypes that look like NHS service pages (using the [Nightingale framework](https://github.com/NHSLeadership/nightingale)). These prototypes can be used to show ideas to people you work with, and to do user research.

## Installation instructions

This guide will walk you through installing and getting started with the prototyping kit.

You’ll use a copy of the kit for each new prototype app you want to make - they’re self contained.

Once installed, the kit uses about 100mb of your computer's disk space.

## Requirements

The prototypking kit runs on MacOS, Windows and Linux. Please make sure you've
got the below requirements:
got the following:

- Admin access to your machine.
- Node.js 6.x.x
- Sublime Text 3
- Admin access to your machine
- Command line tools (Mac)
- Git bash (Windows)
- Git (Mac, Windows and Linux)
- Node.js 6.x.x
- A text editor (We recommend https://atom.io/)

## Terminal

Expand All @@ -27,14 +32,33 @@ line'. We'll need this to install, start and stop the kit.
### MacOS users

Your machine comes with the ```Terminal.app``` application. It's located within
the ```Utilities``` folder. You can also find it by pressing ```cmd +
spacebar``` on your keyboard and typing Terminal.
the ```Utilities``` folder. You can also find it by pressing ```cmd + spacebar``` on your keyboard and typing `Terminal`.

#### Git

There are several ways to install Git on a Mac. If you've installed XCode (or it's Command Line Tools), Git may already be installed. To find out, open a terminal and enter

```git --version```

The response should be a `git version x.x.x`. If not, you may need to re-install XCode Command Line Tools with the `Terminal.app` command:

```xcode-select --install```


### Windows users

TODO
This guide will use Git Bash as a terminal instead of the existing CMD application. Git Bash is more fully featured and uses the same commands as Mac and Linux, so instructions in this guide work for all.

Installing git bash installs two things for you: a terminal (for entering commands), and git (used later to share your work with others).

#### Installing git bash
[Download Git bash](https://git-scm.com/download/win) (direct download).

Install with all default options.


## Check if you have Node.js
## Node.js
### Check if you have Node.js

```node --version```

Expand All @@ -49,34 +73,61 @@ with the default options..
```xcode-select --install```

## Download the kit
```git clone https://github.com/NHSLeadership/nhs-prototyping-kit.git```

TODO: replace with zip instructions.
If you want to get a copy of an existing code repository (from [github.com](https://github.com)) – the command you need is `git clone`.

## Install the kit
To download the latest NHS Prototyping Kit:

TODO
Create a `projects` folder we will keep our prototype apps in:

### Navigate to the prototype
```cd ~/projects/nhs-prototyping-kit```
Browse to your home directory with `cd` (change directory)

TODO: Offer alternative guide to using terminal.
```cd ~```

Create a new directory using `mkdir` and name it `projects`

```mkdir projects```

change directory to the new `projects` folder

```cd projects```

Clone a copy of the latest NHS Prototyping Kit into a folder named `myNewProject` or somethnig else of your choosing

```git clone https://github.com/NHSLeadership/nhs-prototyping-kit.git myNewProject```

Change directory to the new folder

```cd myNewProject```

### Install the kit modules
The NHS Prototyping Kit relies on a number of open source code 'modules' others have created on the web. These need to be added into the app before it can be used. Install the required modules by typing

### Install modules
```npm install```

That's it. You should be all installed and ready to go!

### Run the kit
The NHS Prototyping Kit needs to be running each time you work on it or want to demonstrate your prototype. The kit will watch for changes you make to your prototype code and re-builds itself with each file you alter. To start the kit run

```npm start```

### Check it works

In your web browser, visit http://localhost:3000
In your web browser, visit

[http://localhost:3000](http://localhost:3000)

You should see the prototype welcome page.

### To quit the kit

In terminal press the `ctrl` and `c` keys together.
In terminal press the `ctrl` and `c` keys together. The Prototyping Kit will quit.

**Installation complete**
**Installation and first run complete!**

Congratulations!

---

Much of the work in this kit is repurposed with pride from the great work and support of [GDS](https://github.com/alphagov) coleagues [@joelanman](https://github.com/joelanman) and [@edwardhorsford](https://github.com/edwardhorsford) on https://github.com/alphagov/govuk_prototype_kit.

0 comments on commit 741bcff

Please sign in to comment.