Provides a backend for the EF Carbon navigation API for the
WARNING: Project is under heavy development but follows semantic versioning, expect breakage until this warning is removed.
yarn add @ef-carbon/react-native-navigation-backend-react-navigation
import setup from '@ef-carbon/react-native-navigation-backend-react-navigation' setup();
Read the documentation for API guidance.
The project attempts to make the workflow as frictionless as possible. Any suggestions to improve the work processes are welcomed :metal:
Get up and running using yarn:
yarn install yarn build
yarn watch:test. Unit tests will re-run after any changes to the source code.
The unit tests use Jest.
There are various scripts available that provide the workflow steps for the project:
||Starts the commitizen CLI|
||Returns the project to initial state|
||Returns the project to postinstall state|
||Builds the project|
||Formats the project|
||Lints the project|
||Fixes up simple linting rule violations automatically|
||Validates the CI configuration file|
||Performs linting of TypeScript files|
||Fixes up simple rule violations in TypeScript files|
||Checks the formatting of the TypeScript source code|
||Automatically fixes up formatting violations|
||Makes sure the commits follow the conventional commits style|
||Watches the TypeScript source files for changes|
||Re-runs unit tests on any file changes|
||Tests the project|
||Provides test coverage statistics for the project|
||Runs a set of commands that are needed to pass the CI workflow|
||Performs formatting and linting fixes|
||Builds API documentation|
||Opens up the built API documentation in the default browser|