Skip to main content

Contributing

Contributions are welcome! Please read the full Contributing Guide on GitHub before submitting a pull request.

Quick Start

git clone https://github.com/hexdrinker/pretext-native.git
cd pretext-native
corepack enable
yarn install
yarn build
yarn test

Project Structure

DirectoryDescription
packages/corePlatform-independent layout engine
packages/pretext-nativeReact Native bindings (iOS/Android native modules)
exampleDemo app with 6 screens
docsThis documentation site

Commit Convention

We follow Conventional Commits: feat:, fix:, docs:, refactor:, test:, chore:, perf:.

Running the Example App

cd example
yarn install

# iOS
cd ios && bundle install && bundle exec pod install && cd ..
yarn ios

# Android
yarn android