Skip to content

Conversation

@vhscom
Copy link
Contributor

@vhscom vhscom commented Apr 22, 2024

Updated setup instructions for macOS++

  • Adds instructions for running the app locally.
  • Creates a Troubleshooting section we can use as a FAQ.
  • Includes instructions to serve the Jekyll site locally.
Screenshot 2024-04-23 at 1 10 13 PM

mkimberlin
mkimberlin previously approved these changes Apr 22, 2024
@vhscom vhscom force-pushed the docs-0000/update-macos-install-docs branch from 91fda84 to f0beb38 Compare April 23, 2024 15:47
@vhscom vhscom force-pushed the docs-0000/update-macos-install-docs branch from f35c992 to 301eb30 Compare April 23, 2024 17:09
@vhscom vhscom requested a review from mkimberlin April 23, 2024 17:14
yarn --cwd web-ui start
```

When developing the UI, you can access the Vite server at [http://localhost:5173](http://localhost:5173).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could add something about running the UI unit tests.

  • cd to the web-ui directory.
  • Enter yarn test.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea. I've added that just below and noted both methods for running (with and without --cwd flag.

# Install Podman

This project uses [Podman](https://podman.io/) for containerization.
This project uses [Podman](https://podman.io/) for containerization. Podman is a daemonless container engine for developing, managing, and running Open Container Initiative containers. It is an alternative to Docker and is available without fee for macOS via Homebrew.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to install a specific version of podman (4.9.3) that I could not get with Homebrew.
I downloaded the file podman-installer-macos-arm64.pkg from https://github.com/containers/podman/releases/tag/v4.9.3.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to know for reference. If you're able to isolate the issue you were having with Podman 5.x perhaps that's worth a support ticket to the Podman repo (unrelated example issue I opened yesterday).

@ZacharyKlein ZacharyKlein self-requested a review April 23, 2024 18:46
@vhscom vhscom changed the title docs: update macos environment setup docs: update macos environment setup and more Apr 23, 2024
@mkimberlin mkimberlin merged commit 74afdd5 into develop Apr 23, 2024
@mkimberlin mkimberlin deleted the docs-0000/update-macos-install-docs branch April 23, 2024 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants