diff --git a/README.md b/README.md index fc04cf924f..e5458e517a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![SSW Banner](https://user-images.githubusercontent.com/17246482/213943898-d3d7268c-0636-4469-ad47-4052302cf567.png) -This repository is a v3 of the zzSSW.Website. This website uses NextJS with TinaCMS. +This repository is a v3 of the SSW.Website. This website uses NextJS with TinaCMS. ![](https://github.com/SSWConsulting/SSW.Website/actions/workflows/main-build-and-deploy.yml/badge.svg?) @@ -54,15 +54,15 @@ pnpm build To build the Docker image, execute the following command to extract the necessary Docker build command: -```pswh +```pwsh ./docker-build-cmd.ps1 ``` This script will generate the final Docker build command and automatically copy it to your clipboard. Simply paste the command into your terminal (CMD), and the Docker image build process will commence. -Once, the docker image is ready, run the following command: +Once the docker image is ready, run the following command: -```docker +```bash docker run --env-file .env -p 3000:3000 ssw-website ``` @@ -107,9 +107,9 @@ Test locally to make sure everything still works. ### UI Testing on local -- 1 Make sure you have `CREATE_LEAD_ENDPOINT` environment variable in your `.env` - [Follow steps to setup](https://github.com/SSWConsulting/SSW.Website/wiki/Accessing-the-Third%E2%80%90Party-APIs-Locally) +1. Make sure you have `CREATE_LEAD_ENDPOINT` environment variable in your `.env` - [Follow steps to setup](https://github.com/SSWConsulting/SSW.Website/wiki/Accessing-the-Third%E2%80%90Party-APIs-Locally) -- 2 Run `npx playwright test --ui` in your terminal and make sure your local instance is running in the background. +2. Run `npx playwright test --ui` in your terminal and make sure your local instance is running in the background. ## Run Lighthouse tests locally