Skip to content

Commit

Permalink
Merge pull request #204 from Consensys/EC-READMEfb-incorporation-denv…
Browse files Browse the repository at this point in the history
…-branch

Common Errors section in linea-ens-app/README updated to incl. nvm, canvas & yarn/package manager issues.
  • Loading branch information
Julink-eth authored Jul 23, 2024
2 parents cf9fb37 + 196efa0 commit 0bccb91
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 3 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,12 @@ contract TestL1 is EVMFetchTarget {

- [Node.js](https://nodejs.org/en/download/package-manager) v18.x.
- [pnpm](https://pnpm.io/installation) v9.x
- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install) v1.2
- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install)
- [Docker](https://docs.docker.com/engine/install/)
- [docker-compose](https://docs.docker.com/compose/install/) v1.2x
- [docker-compose](https://docs.docker.com/compose/install/)

## Installation
See [Install](./packages/linea-ens-app/README.md#install) in the linea-ens-app README.

## Packages

Expand Down
1 change: 0 additions & 1 deletion package.json

This file was deleted.

32 changes: 32 additions & 0 deletions packages/linea-ens-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ Most installation errors are due to `Node.js`, `pnpm`, `yarn` or `docker-compose
node --version
v18.20.4
```
Node Version Manager (nvm) can be used to manage multiple versions of Node.js if you find you are not in the correct version of Node.

```bash
pnpm --version
Expand All @@ -218,6 +219,37 @@ docker-compose --version
docker-compose version 1.29.2, build 5becea4c
```

### Canvas issues
It is possible the Canvas libraries are not installed correctly or missing.
To install/reinstall: First install pkg-config:
```bash
brew install pkg-config
```

Then install dependencies for canvas
```bash
brew install cairo pango libpng jpeg giflib librsvg
```

After installing the dependencies, set the PKG_CONFIG_PATH environment variable:
```bash
export PKG_CONFIG_PATH="/opt/homebrew/lib/pkgconfig:/opt/homebrew/share/pkgconfig:$PKG_CONFIG_PATH"
```

Finally clear npm cache and node_modules:
```bash
npm cache clean --force
rm -rf node_modules
```

### Package Manager errors:
If you encounter a Package Manager error this stems from a Yarn compatibility issue. To resolve this we need to disable Yarn that has been bundled in with the latest versions of Node.js and install Yarn separately.

To do so follow these steps in the root folder:
1. `corepack disable`
2. `npm install -g pnpm`
3. `npm install -g yarn`

### EACCES: permission denied, unlink

If you encounter this error:
Expand Down

0 comments on commit 0bccb91

Please sign in to comment.