Skip to content

Commit

Permalink
improv: update integration.md to add postinstall in package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
joshualai9922 committed Jul 15, 2024
1 parent 8629a5b commit cd9e3fd
Showing 1 changed file with 24 additions and 16 deletions.
40 changes: 24 additions & 16 deletions INTEGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,11 +155,13 @@ Change the type of npm package to module by running <code>npm pkg set type="modu

Install the following node dependencies by running <code>npm install cypress @govtechsg/purple-hats --save-dev </code>

Navigate to <code>node_modules/@govtechsg/purple-hats</code> and run <code>npm install</code> within the folder to install remaining Purple A11y dependencies:
Add a `postinstall` script to your `package.json`, to install Purple A11y dependencies:

cd node_modules/@govtechsg/purple-hats
npm install
cd ../../..
"scripts": {
"postinstall": "cd node_modules/@govtechsg/purple-hats && npm install"
}

Run <code>npm install</code> to install remaining Purple A11y dependencies.

Create <code>cypress.config.js</code> with the following contents, and change your Name, E-mail address, and boolean value for whether rule items requiring manual review in the report should be displayed below:

Expand Down Expand Up @@ -301,11 +303,13 @@ Create a <code>tsconfig.json</code> in the root directory and add the following:
}
```

Navigate to <code>node_modules/@govtechsg/purple-hats</code> and run <code>npm install</code> within the folder to install remaining Purple A11y dependencies:
Add a `postinstall` script to your `package.json`, to install Purple A11y dependencies:

"scripts": {
"postinstall": "cd node_modules/@govtechsg/purple-hats && npm install"
}

cd node_modules/@govtechsg/purple-hats
npm install
cd ../../..
Run <code>npm install</code> to install remaining Purple A11y dependencies.

Create <code>cypress.config.ts</code> with the following contents, and change your Name, E-mail address, and boolean value for whether rule items requiring manual review in the report should be displayed below:

Expand Down Expand Up @@ -460,11 +464,13 @@ Change the type of npm package to module by running <code>npm pkg set type="modu

Install the following node dependencies by running <code>npm install playwright @govtechsg/purple-hats --save-dev</code> and <code>npx playwright install</code>

Navigate to <code>node_modules/@govtechsg/purple-hats</code> and run <code>npm install</code> within the folder to install remaining Purple A11y dependencies:
Add a `postinstall` script to your `package.json`, to install Purple A11y dependencies:

cd node_modules/@govtechsg/purple-hats
npm install
cd ../../..
"scripts": {
"postinstall": "cd node_modules/@govtechsg/purple-hats && npm install"
}

Run <code>npm install</code> to install remaining Purple A11y dependencies.

On your project's root folder, create a Playwright test file <code>purpleA11y-playwright-demo.js</code>:

Expand Down Expand Up @@ -549,11 +555,13 @@ Create a <code>tsconfig.json</code> in the root directory and add the following:
}
```

Navigate to <code>node_modules/@govtechsg/purple-hats</code> and run <code>npm install</code> within the folder to install remaining Purple A11y dependencies:
Add a `postinstall` script to your `package.json`, to install Purple A11y dependencies:

"scripts": {
"postinstall": "cd node_modules/@govtechsg/purple-hats && npm install"
}

cd node_modules/@govtechsg/purple-hats
npm install
cd ../../..
Run <code>npm install</code> to install remaining Purple A11y dependencies.

Create a sub-folder and Playwright test file <code>src/purpleA11y-playwright-demo.ts</code> with the following contents:

Expand Down

0 comments on commit cd9e3fd

Please sign in to comment.