Table of Contents

• TODO List
• Dependencies
• Getting Started
  • Running Storybook
    • On-Device
    • Web
• Working on Components
• Building for Release

TODO List

• Add Github Action to build and release with automatic versioning
• Add LICENSE
• Add CONTRIBUTING guide

Dependencies

This project uses Heroicons for icons.

Getting Started

Running Storybook

First, navigate to the docs folder:

cd ./docs

On-Device

You can run yarn storybook to start on-device Storybook or yarn start to start your Expo app. This functionality is controlled via environment variables and Expo constants.

# Start Storybook (default)
yarn storybook

# iOS
yarn storybook:ios

# Android
yarn storybook:android

To update stories for the native (on-device) version:

yarn storybook-generate

Web

To start React Native Web Storybook:

yarn storybook:web

To build React Native Web Storybook:

yarn build-storybook

Working on Components

To work on components:

1. Navigate to the docs folder: cd ./docs
2. Create new components in the src/components folder
3. Follow these guidelines:
   • All components must have a story file named [ComponentName].stories.tsx
   • All components must have a type file named [ComponentName].types.ts
   • Create the main component file [ComponentName].tsx
4. Add the new component to src/index.ts to make it accessible
5. Build and commit your changes

Building for Release

To build for release:

npm run build

For continuous building during development:

npm run build:watch

---

We welcome contributions! Please check back soon for our CONTRIBUTING guide.