The example app is used as the basis of building and testing the core library. If you have an issue that we're unable to reproduce easily, we'll likely ask you to come here, build and run the example app, and see if you can reproduce it in that app.
The most important thing to know about how to run this project, is to understand
that it installs the react-native-readium library located in the parent
directory (../) and NOT from npm. This means that before you can properly
run the example you need to build the core library. Similarly, if you make a
change to the code located in the parent directory, you need to rebuild then
reinstall it in the example directory.
Here are the steps:
All commands are going to be run from the root directory. Meaning relative to
this file you should run them from ../.
yarn bootstrap
The bootstrap command builds the parent project and installs it in the example.
All commands are going to be run from the root directory. Meaning relative to
this file you should run them from ../.
Start Metro
yarn example start
Run iOS or Android
yarn example [android | ios]
Ex. yarn example ios.
Thats it! 🎉, you should now be running the example project.