Skip to content

Commit

Permalink
GPG-NONE: Revise documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
LadunOmideyiSoftwire committed Dec 1, 2022
1 parent 06eb617 commit 666fcec
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
5 changes: 2 additions & 3 deletions Documentation/Getting the code running.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Run the code:

Populate the database:
* Create yourself 2 accounts (employer account & admin account) on the Dev environment
['Create an account' page on the Dev environment](https://gender-pay-gap-dev.london.cloudapps.digital/create-user-account)
['Create an account' page on the Dev environment](https://dev.gender-pay-gap.service.gov.uk/create-user-account)
**Note:** see ['Our environments' page](Our%20environments.md) for details about the username/password prompt
* Sign up for an account
* Ask an existing developer to send you the email verify link. Alternatively, if you're a Softwire developer, check the "Finding the email verify link" section [here](https://softwiretech.atlassian.net/wiki/spaces/LAX/pages/8989377266/GPG+Zero+to+Hero).
Expand All @@ -62,12 +62,11 @@ Populate the database:
Note: this page is only visible to admins, or when the database is empty
Note: this page works better in Chrome than in Firefox
* Fill in the form:
* Hostname of remote server: `gender-pay-gap-dev.london.cloudapps.digital` (without https://)
* Hostname of remote server: `dev.gender-pay-gap.service.gov.uk` (without https://)
* Passwords: ask an existing developer for these. Alternatively, if you're a Softwire developer, check the "How to access the dev site" section [here](https://softwiretech.atlassian.net/wiki/spaces/LAX/pages/8989377266/GPG+Zero+to+Hero).
* The database migration password is stored in `appsettings.secrets.json`
* Click the scary red button
* Wait for a few minutes whilst the data is imported
* The database should now be fully populated and ready to use
* You can now login using the accounts you just created in the Dev environment
The credentials will be exactly the same as in Dev (because we just copied the whole Dev database to your local machine)

9 changes: 8 additions & 1 deletion Documentation/Software to install.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,11 @@ Install the following software:

* Node Package Manger (NPM) (comes with Node.js)
[Download Node.js & npm](https://nodejs.org/en/download/)
If you're using Windows, you probably want to download the LTS installer from that page
If you're using Windows, you probably want to download the LTS installer from that page

* Terraform v1.3+ -
You can find installation instructions [here]('https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli')
If you are installing Terraform using the binary, make sure you have added Terraform to your path (as described above)

* AWS CLI v2
You can find installation instructions [here]('https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html'). You will need to configure the AWS CLI with the credentials given to you by the your AWS administrator

0 comments on commit 666fcec

Please sign in to comment.