Skip to content

Latest commit

 

History

History
116 lines (80 loc) · 3.92 KB

README.md

File metadata and controls

116 lines (80 loc) · 3.92 KB
Raw

NHS Notify Template Management (WebUI) Repository

Setting up locally

Git

  • Make sure you have GitHub access with the right permissions
  • Setup git locally on your machine
  • Set your local git email as you *@nhs.net email e.g. git config --global user.email "[email protected]"
  • Setup commit signing (this is required before you can commit any code to the repository). This is a very good resource to help Mac users https://gist.github.com/troyfontaine/18c9146295168ee9ca2b30c00bd1b41e
  • Pull the repository here [email protected]:NHSDigital/nhs-notify-web-template-management.git

Development and Tools

  • Install asdf HERE. We use this tool to manage the required version for packages (this can be found in the .tool-versions file at the root of the project) on the project. You can use other tools usch as brew, apt, etc, but you will be risking having different package versions to other developers.
  • Then you need to install the following plugins:
  asdf plugin-add nodejs
  asdf plugin-add direnv
  asdf plugin-add terraform
  asdf plugin-add gitleaks
  asdf plugin-add pre-commit
  • Now you can install the tools, and they will be runnable from within the nhs-notify-web-template-management directory:
  asdf install
  • Now you can run the command below to install the packages in the project:
  npm install

Running the project locally

  1. Convert the email HTML template into a JSON file that can be packaged with the email sending lambda.

    npm run generate-dependencies

  2. (Optional) If you want to test sending emails then you will need to set the following environment variables locally.

    export ACCOUNT_ID=<aws_account_id>
export NOTIFY_DOMAIN_NAME=<ses_verified_domain>

  3. To run an Amplify sandbox. To do this, authenticate with an AWS account that has Amplify enabled, then run:

    npx ampx sandbox --profile <the name of the AWS config profile for the account you are authenticated with>

  4. To create a Terraform backend sandbox, run:

    npm run create-backend-sandbox <environment-name>

  5. Then in a separate terminal, run the app locally:

    npm run dev

  6. Open your browser and go to localhost:3000 to view the app.

  7. To destroy an Amplify sandbox, run:

    npm run destroy-sandbox -- --profile <the name of the AWS config profile for the account you are authenticated with>

  8. To destroy a Terraform backend sandbox, run:

    npm run destroy-backend-sandbox <environment-name>

Other commands

  • Unit test npm run test:unit
  • Accessibility test npm run test:accessibility

You can find more commands in the package.json file

Running Team and IAM Web Auth projects locally

Read more in the README.md.

Project structure

  • components ./src/components
  • pages ./src/app
  • SCSS Styles ./src/styles
  • App contents `./src/content
  • Unit tests (Components) ./src/__tests__/components
  • Unit tests (Pages) ./src/__tests__/pages
  • Utilities functions ./src/utils
  • Types ./src/types

Shared Terraform Modules

Before you setup modules for this repository and find that there might be modules that can be reused elsewhere, please do check out https://github.com/NHSDigital/nhs-notify-shared-modules/. If you find that the modules are shareable, you should set them up there as a separate PR and get that merged in and potentially tag the commit after testing it, so that it can be a stable release that can be used across all repos on Notify should others find the need to re-use that new module. You can simply point to the reference in your module call as below:

module "amp_branch" {
  source = "git::https://github.com/NHSDigital/nhs-notify-shared-modules.git//infrastructure/modules/amp_branch?ref=v1.0.0"
  ...
}