Skip to content

Commit 7199d27

Browse files
committed
chore: add CONTRIBUTING.md and describe demo apps in docs
1 parent bbd5f2a commit 7199d27

3 files changed

Lines changed: 36 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing to React Native Brownfield
2+
3+
## Project setup
4+
5+
Run `yarn` in the root of the repository to install all dependencies.
6+
7+
Depending on your needs, you may need to install CocoaPods in a subset of the below directories:
8+
- example React Native iOS app: `cd apps/RNApp/ios && pod install`
9+
- integrated iOS tester app: `cd apps/tester-integrated/swift && pod install`
10+
11+
## Scripts
12+
13+
- `lint` - runs linting on all JS/TS source files in the monorepo *[Turbo]*
14+
- `typecheck` - runs TypeScript type checking on all TS source files in the monorepo *[Turbo]*
15+
- `build` - runs all `build*` tasks in the Turbo repo - see below for more details *[Turbo]*
16+
- `release` - releases a new version of React Native Brownfield package using `release-it`
17+
- `brownfield:plugin:publish:local` - publishes the Brownfield Gradle plugin to your local Maven repository for testing purposes
18+
- `build:brownfield` - builds the React Native Brownfield package (`packages/react-native-brownfield`) *[Turbo]*
19+
- `build:docs` - builds the documentation site (`docs/`) *[Turbo]*
20+
- `build:tester-integrated:android` - builds the Android integrated tester app (`apps/tester-integrated/android`) *[Turbo]*
21+
- `build:tester-integrated:ios` - builds the iOS integrated tester app (`apps/tester-integrated/swift`) *[Turbo]*
22+
- `build:example:android-rn` - builds the example React Native app for Android (`apps/RNApp/android`) *[Turbo]*
23+
- `build:example:ios-rn` - builds the example React Native app for iOS (`apps/RNApp/ios`) *[Turbo]*
24+
- `build:example:android-consumer` - builds the example native Android consumer app (`apps/AndroidApp`) *[Turbo]*
25+
- `build:example:ios-consumer` - builds the example native iOS consumer app (`apps/iOSApp`) *[Turbo]*
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
["introduction", "quick-start"]
1+
["introduction", "quick-start", "examples"]
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Examples
2+
3+
You can find example projects demonstrating the usage of React Native Brownfield in the [apps](https://github.com/callstack/react-native-brownfield/tree/master/apps) directory.
4+
5+
It contains the following apps:
6+
7+
- `RNApp` - a React Native app that is packaged using React Native Brownfield to an artifact consumed in native apps, in which you can refer to an exemplar usage of the library for packaging a React Native app to a consumable artifact
8+
- `AndroidApp` - an Android app consuming the packaged artifact from `RNApp`, in which you can refer to an exemplar usage of the library for integrating React Native Brownfield into a native Android app
9+
- `iOSApp` - an iOS app consuming the packaged artifact from `RNApp`, in which you can refer to an exemplar usage of the library for integrating React Native Brownfield into a native iOS app
10+
- `tester-integrated` - a native app (iOS and Android) with React Native Brownfield integrated directly into the native project without the intermediate step of packaging an artifact; this app serves mostly internal repo testing purposes

0 commit comments

Comments
 (0)