React Navigation 5
Routing and navigation for your React Native apps with a component-first API.
Documentation can be found at next.reactnavigation.org.
The project uses a monorepo structure for the packages managed by yarn workspaces and lerna. To get started with the project, run
yarn in the root directory to install the required dependencies for each package:
yarn example start
Make sure your code passes TypeScript and ESLint. Run the following to verify:
yarn typescript yarn lint
To fix formatting errors, run the following:
yarn lint --fix
Remember to add tests for your change if possible. Run the unit tests by:
Running the e2e tests with Detox (on iOS) requires the following:
- Mac with macOS (at least macOS High Sierra 10.13.6)
- Xcode 10.1+ with Xcode command line tools
First you need to install
brew tap wix/brew brew install applesimutils yarn global add detox-cli
Then you can build and run the tests:
detox build -c ios.sim.debug detox test -c ios.sim.debug
To publish a new version, first we need to export a
GH_TOKEN environment variable as mentioned here. Then run:
yarn lerna publish
This will automatically bump the version and publish the packages. It'll also publish the changelogs on GitHub for each package.
Installing from a fork on GitHub
Since we use a monorepo, it's not possible to install a package from the repository URL. If you need to install a forked version from Git, you can use
yarn global add gitpkg
Then follow these steps to publish and install a forked package:
- Fork this repo to your account and clone the forked repo to your local machine
- Open a Terminal and
cdto the location of the cloned repo
yarnto install any dependencies
- If you want to make any changes, make them and commit
cdto the package directory that you want to use (e.g.
gitpkg publishto publish the package to your repo
After publishing, you should see something like this:
Package uploaded to email@example.com:<user>/<repo>.git with the name <name>
You can now install the dependency in your project:
yarn add <user>/<repo>.git#<name>
Remember to replace
<name> with right values.