Skip to content
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.

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

Add troubleshooting note in CONTRIBUTING.md #2110

Merged
merged 14 commits into from
Sep 30, 2024
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,11 @@ Now you're ready to begin development. Start the development server:
npm start
```

> _*Note*_: If you face any issues running this, we recommend installing Node.js v18:
>
> 1. Delete `package-lock.json` and `node_modules`.
> 2. Run `npm install` to reinstall dependencies.

This will serve the app at [localhost:4141](http://localhost:4141/), and watch files in `/src` for changes. It will also update the `/lib` directory, which contains a Babel-compiled copy of the source. This directory is exported to `npm`, and is used when importing as a React component into another application. It is updated automatically when you save in case you need to test/debug it locally (e.g. with `npm link`). You can also update it manually, by running

```bash
Expand Down
Loading