Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter Piekarczyk committed May 25, 2021
1 parent b27199e commit 5ebdec0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,23 @@ up by the Metro bundler and reflected in the example application.
Please read the [contributing guide](CONTRIBUTING.md) before making
a pull-request and to understand the full development flow

## Overview

This is a lerna/monorepo setup that is split up into types, native, core and ui packages.

- packages/ui: pulls in everything from core and native and re-exports it. This is what any user will install to use this Library
- packages/core: Non-native, javascript components go here. These are components that work perfectly across web, ios and android without any adjustments
- packages/native: Native components that rely on expo/react-native modules likes `expo-av` and `@expo/vector-icons`. This houses our AudioPlayer and Icon components because the current version requires modifications to work well on Web
- packages/types: Shared typescript types and SEED_DATA types which is how we build the translation layer for Draftbit

### SEED_DATA

You'll notice that most components will have `SEED_DATA` at the bottom of their files. This is how we incorporate components and props into Draftbit's property panel.

The object at the bottom maps one to one to what the UI will look like in the panel. Here's an example of the "View" component:

![Draftbit Properties Panel](./images/view-properties-panel.png)

## Linking

If you want to dynamically link these packages into a project using `yarn link`,
Expand Down
Binary file added images/view-properties-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5ebdec0

Please sign in to comment.