Skip to content

Commit

Permalink
Update setup docs to include Yarn (gravitational#21055)
Browse files Browse the repository at this point in the history
Include references to install Yarn for building the UI, as well as the
alternative "docker-ui" make target.

The Yarn install process is currently dependent on yarn 1.x / pre-2.0
  • Loading branch information
jof authored Feb 10, 2023
1 parent 810a89c commit 48d91ab
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
4 changes: 4 additions & 0 deletions BUILD_macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
The instructions below are provided as in a best-effort basis.
PRs with corrections and updates are welcome!

* Install [Homebrew](https://brew.sh/)
* `Go` version from
[go.mod](https://github.com/gravitational/teleport/blob/master/go.mod#L3)

Expand Down Expand Up @@ -70,6 +71,9 @@ PRs with corrections and updates are welcome!
brew install libfido2
```

* To install `yarn` for building the UI
* `brew install node yarn`
* Currently, [`yarn`](https://classic.yarnpkg.com/en/docs/install) (< 2.0.0) is required
##### Local Tests Dependencies

To run a full test suite locally, you will need
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,8 @@ Ensure you have installed correct versions of necessary dependencies:
[build.assets/Makefile](https://github.com/gravitational/teleport/blob/master/build.assets/Makefile#L21)
(search for `RUST_VERSION`)
* For `tsh` version > `10.x` with FIDO support, you will need `libfido` and `openssl 1.1` installed locally
* To build the web UI, [`yarn`](https://classic.yarnpkg.com/en/docs/install)(< 2.0.0) is required.
* If you prefer not to install/use yarn, but have docker available, you can run `make docker-ui` instead.

For an example of Dev Environment setup on a Mac, see [these instructions](BUILD_macos.md).

Expand Down

0 comments on commit 48d91ab

Please sign in to comment.