search

evoluhq / evolu

A local-first platform designed for privacy, ease of use, and no vendor lock-in
https://evolu.dev
MIT License
1.3k stars 44 forks source link

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

Open samwightt opened 1 week ago

samwightt commented 1 week ago

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:

For React Native, the following need to be installed:

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 commented 1 week ago

You are awesome, will update docs asap.