You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+27-18Lines changed: 27 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,9 @@ We want this community to be friendly and respectful to each other. Please follo
8
8
9
9
This project is a monorepo managed using [Yarn workspaces](https://yarnpkg.com/features/workspaces). It contains the following packages:
10
10
11
-
- The library package in the root directory.
12
-
- An example app in the `example/` directory.
11
+
- The core library package in the `packages` directory
12
+
- React Native example app in `apps/example`
13
+
- Expo example app in `apps/example-expo`
13
14
14
15
To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
15
16
@@ -19,46 +20,54 @@ yarn
19
20
20
21
> Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli) for development.
21
22
22
-
The [example app](/example/) demonstrates usage of the library. You need to run it to test any changes you make.
23
+
The example apps in the `apps` directory demonstrate usage of the library. You need to run one of them to test any changes you make.
23
24
24
-
It is configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example app. Changes to the library's JavaScript code will be reflected in the example app without a rebuild, but native code changes will require a rebuild of the example app.
25
+
They are configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example apps. Changes to the library's JavaScript code will be reflected without a rebuild, but native code changes will require a rebuild of the example app.
25
26
26
-
If you want to use Android Studio or XCode to edit the native code, you can open the `example/android` or `example/ios` directories respectively in those editors. To edit the Objective-C or Swift files, open `example/ios/SwiftuiTabviewExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > react-native-bottom-tabs`.
27
-
28
-
To edit the Java or Kotlin files, open `example/android` in Android studio and find the source files at `react-native-bottom-tabs` under `Android`.
27
+
If you want to use Android Studio or XCode to edit the native code, you can open the `apps/example/android` or `apps/example/ios` directories respectively in those editors.
29
28
30
29
You can use various commands from the root directory to work with the project.
31
30
32
-
To start the packager:
31
+
To start the packager for the React Native example:
0 commit comments