Skip to content

Commit

Permalink
chore: Lock yarn version to classic (#2047)
Browse files Browse the repository at this point in the history
Enables installing the app with yarn 2+.
  • Loading branch information
SuaYoo authored Aug 26, 2024
1 parent 95969ec commit d119e8f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
23 changes: 19 additions & 4 deletions docs/develop/frontend-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,42 @@ Instead of rebuilding the entire frontend image to view your UI changes, you can

The frontend development server requires an existing backend that has been deployed locally or is in production. See [Deploying Browsertrix](../deploy/index.md).

### 2. Node.js ≥18 and Yarn 1
### 2. Node.js ≥18

To check if you already have Node.js installed, run the following command in your command line terminal:

```sh
node --version
```

You should see a version number like `v18.12.1`. If you see a command line error instead of a version number, [install Node.js](https://nodejs.org) before continuing.
You should see a version number like `v18.12.1`. If you see a command line error instead of a version number, [install Node.js](https://nodejs.org/en/download/package-manager) before continuing.

??? question "What if my other project requires a different version of Node.js?"

You can use [Node Version Manager](https://nodejs.org/en/download/package-manager#nvm) to install multiple Node.js versions and switch versions between projects.

To check your Yarn installation:
### 3. Yarn 1 (Classic)
To verify your Yarn installation:

```sh
yarn --version
```

You should see a version number like `1.22.19`. If you do not, [install or upgrade Yarn](https://classic.yarnpkg.com/en/docs/install).
If your Yarn version starts with `1` (e.g. `1.22.22`) you're good to go.

If Yarn isn't installed, install [Yarn 1 (Classic)](https://classic.yarnpkg.com/en/docs/install#mac-stable).

If your Yarn version is `2.0` or greater, run the following from your Browsertrix project directory to enable Yarn 1:


```sh
cd frontend
corepack enable
corepack install
```

Check out the full [Yarn + Corepack installation guide](https://yarnpkg.com/corepack) for more details.


## Quickstart

Expand Down
3 changes: 2 additions & 1 deletion frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -144,5 +144,6 @@
},
"browserslist": [
"defaults"
]
],
"packageManager": "[email protected]+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
}

0 comments on commit d119e8f

Please sign in to comment.