diff --git a/README.md b/README.md index 24d1b91..b598d09 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ This repository contains the code used to redesign the existing "Claim Status" a JavaScript scripts are injected onto the existing application and manually update the layout and content for a better user experience. Rather than updating the existing JSP code directly, this will enable frequent testing on dev and deployments to prod without OIM as a dependency, both in terms of infrastructure and bandwidth. See `CHANGELOG.md` for list of updates made to production. +The script files are hosted on the `beta.nj.gov` domain and automatically pushed from the `beta` Github repository. This repository houses the code and tests for developing the scripts, while the `beta` repository simply houses the compiled assets that need to be hosted. Note that there is a `dev` and `prod` hosting of the scripts, which corresponds to the dev and prod (https://secure.dol.state.nj.us/DOL_DABI/) versions of the Claim Status application. + ## Setup 1. Clone this `paid-leave-claim-status` repository @@ -14,7 +16,7 @@ JavaScript scripts are injected onto the existing application and manually updat 4. Run `npm run build` to build bundled files 5. Run `npm test` to run Cypress tests -## Testing a change +## Development When you make a change and want to see if everything is working, do the following: @@ -22,10 +24,13 @@ When you make a change and want to see if everything is working, do the followin 2. Run `npm run build` to compile files 3. Run `npm test` to ensure tests still pass 4. Open relevant test file in `cypress/fixtures` in browser to ensure change looks okay (edit or add new test file if your scenario is not covered) +5. After code review, push changes to `dev` branch. This will automatically deploy test files on Github pages under the URL https://newjersey.github.io/paid-leave-claim-status/... These test links can be used to share the view under specific claim scenarios with your team. +6. After the test links have been reviewed, deploy the changes to the dev site. See instructions below for deployment. Reach out to your OOI team or the Department of Labor to get the Claim Status dev URL. ## Deployment -1. Clone the `beta` repository in the same local folder that the `paid-leave-claim-status` folder is in -2. Run `npm run build` to build latest files into bundle -3. Run `npm run prep-deploy-dev` (or `prep-deploy-prod` based on intended stage), which should copy the files into the correct `beta` directory -4. Push files to `main` branch of `beta` repo, and they will be automatically deployed to `beta.nj.gov` to be referenced by the Claim Status application +1. In `paid-leave-claim-status` repository, create a PR to squash & merge changes from `dev` into `prod`. Note that this change does not directly affect deployment, it is just to keep the change history log up to date. +2. Clone the `beta` repository in the same local directory where the local files for the `paid-leave-claim-status` repo live. +3. Use Node 20 and `npm run build` to build latest files into bundle. +4. Run `npm run prep-deploy-dev` (or `prep-deploy-prod` based on intended stage), which should copy the files into the correct `beta` directory +5. Push files to `main` branch of `beta` repo, and they will be automatically deployed to `beta.nj.gov` to be referenced by the Claim Status application