Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GitHub and Heroku guidance #213

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/get-started/github-and-heroku.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: layouts/get-started.njk
title: GitHub and Heroku
tags:
- getStarted
---

You can use GitHub to store your prototype securely and Heroku to run it for user testing.

## Setting up Git

You first need to follow the NHS prototype guidance on [setting up Git](https://prototype-kit.service-manual.nhs.uk/how-tos/git).

## Storing your code in GitHub

Prototypes should be stored as repositories in the [GitHub NHS Digital](https://github.com/NHSDigital) organisation account.

You can find guidance on how to [get access to the GitHub NHS Digital organisation](https://nhs.sharepoint.com/:u:/r/sites/X26_EngineeringCOE/SitePages/GitHub-User---how-to-request-access.aspx?csf=1&web=1&e=7WzUKB) on SharePoint.

### Naming your prototype in GitHub

You should name your prototype to prevent people getting confused with production services. Use `nhsapp-prototype-` followed by the name of your service, for example: `nhsapp-prototype-prescriptions`

## Using Heroku to host your prototype

Depending on what testing you plan to do with users, you might want to run your prototype as a website, rather than on your local device.

We use Heroku to host prototypes. To host an NHS App prototype on Heroku, you first need to store your code on GitHub, then [contact the NHS App design system team](/community/help-and-feedback/), who will setup an Heroku app and URL for you.