Skip to content

docs: add troubleshooting section to README #2944

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

Open
0xEdmundo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add troubleshooting section to README #2944

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,21 @@ There are three projects which can be run individually.
yarn workspace @app/web dev
```

## Troubleshooting

Common issues and their solutions:

| Issue | Solution |
|-------|----------|
| `yarn` command not found | Enable Corepack: `corepack enable` |
| Node version mismatch | Run `nvm use` to load the correct Node.js version |
| Build fails with memory error | Increase Node memory: `export NODE_OPTIONS="--max_old_space_size=4096"` |
| Port already in use | Kill the process: `lsof -i :3000` then `kill -9 <PID>`, or use a different port |
| Dependencies not resolving | Clear cache: `yarn cache clean` and reinstall: `yarn install --force` |
| TypeScript errors after pull | Run `yarn build` to regenerate type definitions |

For additional help, join the [Base Discord](https://base.org/discord) and ask in #developer-chat.

## Contributing

We welcome contributions to Base! For guidelines on how to contribute please refer to [CONTRIBUTING.md](CONTRIBUTING.md).
Expand Down