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

[Documentation]: Peer dependency installation needs to be documented. #475

Open
samwightt opened this issue Sep 8, 2024 · 1 comment
Open

Comments

@samwightt
Copy link
Contributor

Evolu's packages require various peer dependencies that need to be installed along with the Evolu package the user is consuming. If these aren't installed in a package manager like Yarn, then TypeScript and bundlers won't work correctly. Everything works right in Npm because npm hoists packages, but Yarn does not.

For React, the following need to be installed:

  • @evolu/common
  • @evolu/common-web
  • @evolu/common-react
  • @sqlite.org/sqlite-wasm
  • @effect/platform
  • @effect/schema (I think?)

For React Native, the following need to be installed:

  • @evolu/common
  • @evolu/common-react
  • @evolu/common-web
  • @evolu/react
  • @effect/platform
  • @effect/schema (I think?)
  • @evolu/react-native
  • expo-sqlite
  • @sqlite.org/sqlite-wasm

Basically go through @evolu/react-native` and its deps and put all of the peer dependencies that are necessary into the docs. It would be great if the docs were updated with the packages needed to install.

@steida
Copy link
Contributor

steida commented Sep 9, 2024

You are awesome, will update docs asap.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants