Skip to content

Add troubleshooting notes to README for canvas dependency issue #167

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.

Sign up for GitHub

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

Merged
codytodonnell merged 2 commits into from
Mar 11, 2024
Merged

Add troubleshooting notes to README for canvas dependency issue #167

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f4d151
Add troubleshooting notes to README for canvas dependency issue
codytodonnell Mar 11, 2024
7fc2fde
Add note about the cause of the m2 error
codytodonnell Mar 11, 2024
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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,18 @@ Run `nvm install` to install and use the node version from `.nvmrc`.
- If you receive the following error message after running `npm start`:
`Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.`
then you may need to set the following environment variable: `DANGEROUSLY_DISABLE_HOST_CHECK=true`
- If you are using a Mac with an M1 or M2 chip, you may run into an
error caused by `canvas` and `node-gyp` after running `npm install`.

- First, make sure your global python version (`python --version`)
is under 3.12.
- If the install step still isn't working, try to install node-canvas
from source by following the Installation: Mac OS X, HomeBrew steps below
or on [this page](https://github.com/Automattic/node-canvas/wiki/Installation:-Mac-OS-X).

- `brew install pkg-config cairo pango libpng jpeg giflib librsvg`
- This python aspect of this issue may become obsolete once
the `node-gyp` peer dependency is able to upgrade to v10+.


## Available Scripts
Expand Down