Merge branch 'master' into IDAM-532-Rebrand

Author: johnholland-nice

README.md

@@ -1,6 +1,7 @@
 #  Nice Identity and Access Management (IdAM) Hosted Pages
 
 > Contains the login/register/password reset etc pages deployed to Auth0. 
+> Also contains the email templates users recieve to verify their email address, to reset their password, if their account has been blocked, and if their account has been compromised.
 > Also blank templates for the configuration of the Auth0 tenants. The actual configuration values are inserted dynamically on deployment via Octopus deploy.
  
 <details>
@@ -15,21 +16,33 @@
 </details>
 
 ## What is it?
-Overview
+
+### Pages
 
 This repo contains a react app, created using create-react-app. It's located in the folder: /custom-pages/universal-login
 
 That react app, builds a login page, password reset page and error page, to the location /custom-pages/pages
 
-The whole custom-pages directory is then deployed to the Auth0 tenant. 
+The whole custom-pages directory is then deployed to the Auth0 tenant.
+
+### Emails
+
+This repo contains email templates. They are located in the folder /custom-pages/emails
+
+You can run npm start in the emails folder to generate the emails as html files with inline css. These get built inside the emails folder but are not tracked. If you want to make changes, change the template or styles files in the src folder, not the built files.
+
+The version of node for the emails is purposefully lower than that for the pages, as it needs to work with gulp. The versions are pinned with volta so you don't need to worry about setting them yourself, and the build steps in team city reflect this.
+
+### Other stuff
 
 All the other files in this repo are mostly blank configuration templates deployed to Auth0 to configure the tenants. The secure configuration values are stored in Octopus Deploy and are inserted at deployment time.
 
 ## Stack
 
 - [React](https://reactjs.org/) front-end
     - [Jest](https://facebook.github.io/jest/) for JavaScript tests
+
+- [Gulp](https://gulpjs.com/) building emails
 
 - [Configuration Deployment Command Line Client](https://auth0.com/docs/extensions/deploy-cli)
   - [Configuration Directory Structure](https://auth0.com/docs/extensions/deploy-cli/guides/import-export-directory-structure)
-