Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore/update readme #115

Merged
merged 5 commits into from
Jun 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,35 @@ A place to learn and share with developers what makes web work accessible. This
- You can find the path to the installed PHP using `which php`. Add that path to your terminal profile's PATH environment value and/or VS Code settings.
- Java: required in order to use the v.Nu checker during automation and unit testing

- Install options:

- Brew Install Options:

- ```bash
brew install java
```
- ```bash
brew install openjdk
```
- Additional tasks

- ```bash
java -version
```

If you get "Unable to locate a Java Runtime", proceed to next step.

- Ensure your symlink is correctly mapped (these instructions will also appear after you brew install java)

- ```bash
sudo ln -sfn /opt/homebrew/opt/openjdk/libexec/openjdk.jdk \
/Library/Java/JavaVirtualMachines/openjdk.jdk
```

- Manual Install Options:
- Mac Install <https://www.java.com/en/download/help/mac_install.html>
- Windows Install <https://www.java.com/en/download/help/windows_manual_download.html>

> Note: Any changes to these prerequisites will need to be reflected in the GitHub Actions in order to run the CI/CD checks.

#### Optional installations (since `npm run server` will run an express server)
Expand Down Expand Up @@ -59,6 +88,8 @@ A place to learn and share with developers what makes web work accessible. This

> See the [Chromedriver issues](#chromedriver-issues) section if you encounter an error related to Chromedriver.

> Make sure your local server is running in another terminal before running `npm run test`.

## Tests

### Tools used for testing
Expand Down
Loading