From d0a8f542f8c96c35443ab4f404ace40fdfa4a823 Mon Sep 17 00:00:00 2001 From: vickytnz Date: Wed, 18 Dec 2024 21:41:39 +0000 Subject: [PATCH] Add more detailed guidance about GitHub --- .../publish-your-prototype-online.html | 36 ++++++++++++------- 1 file changed, 24 insertions(+), 12 deletions(-) diff --git a/app/views/how-tos/publish-your-prototype-online.html b/app/views/how-tos/publish-your-prototype-online.html index a885c636..7243da4a 100644 --- a/app/views/how-tos/publish-your-prototype-online.html +++ b/app/views/how-tos/publish-your-prototype-online.html @@ -22,16 +22,19 @@

Publish your prototype online

You'll need a hosting service to publish prototypes online.

Hosting services

-

The NHS prototype kit runs on any hosting service that supports Node.js.

+

The NHS prototype kit runs on any hosting service that supports Node.js. This means it does not run on 'static' hosting services like GitHub Pages or Netlify.

Your organisation may already use a hosting service for the prototype kit. Check with your digital team about which platform to use.

-

For example:

+

If you are using GitHub to store your code online

+

Many hosting services automatically deploy your prototype every time you merge new changes in the connected GitHub repository. Usually you can enable automatic deploys.

+

This includes:

-

In Railway, you need to set the command to get started. Go to Settings > Deploy and set it to npm run start.

-

Some hosting services may automatically deploy your prototype every time you merge new changes in the connected GitHub repository. You may be able to enable automatic deploys. If it hasn't automatically updated your prototype, you will need to do this manually.

+

Other ways to get your code onto a hosting service

+

Usually you can connect your code using Git. Use our Git guide and then instructions from your hosting service (for example, Heroku or Railway).

+

Setting a password

When running the prototype kit online, you must set a password. This is to stop anyone accidentally finding your prototype and mistaking it for a real service.

To set a password, check your hosting services documentation on how to set "environment variables". (It may have a slightly different name like "config vars" or "variables".)

@@ -39,17 +42,26 @@

Setting a password

If you are using an older version of the prototype kit (before v4.12.0) you will also need to set a username using the variable PROTOTYPE_USERNAME.

-

In Railway, you also need to create:

+

Read more about environment variables for:

-

Read more about:

+

If Railway is your hosting service

+ +

You need to do some extra things to run your prototype online using Railway.

+ + +

Add 2 more environment variables:

+ +

You also need to set the command to get started. Go to Settings > Deploy and set it to npm run start.

+ +