Skip to content

Commit 7dcd70a

Browse files
eat: example app's readme.md (#1452)
## 📜 Description - added a `example/README.md` with a `screenshot.png` to help how to run the example app. ## 💡 Motivation and Context I was not able to run the example app instinctively: #1451 Closes #1451 ## 📢 Changelog Just doc. ## 🤔 How Has This Been Tested? Yes, I managed to read it. XD ## 📸 Screenshots (if appropriate): <img width="1912" height="782" alt="image" src="https://github.com/user-attachments/assets/5cc4bf8a-e4cc-499b-bf32-b276caa6813e" /> ## 📝 Checklist - [ ] CI successfully passed - [ ] I added new mocks and corresponding unit-tests if library API was changed --------- Co-authored-by: kirillzyusko <zyusko.kirik@gmail.com>
1 parent 1a6450e commit 7dcd70a

3 files changed

Lines changed: 74 additions & 0 deletions

File tree

FabricExample/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# FabricExample
2+
3+
This example app runs on the [New Architecture](https://reactnative.dev/docs/the-new-architecture/landing-page) (Fabric).
4+
5+
## Run the app
6+
7+
<img src="../gifs/example-screenshot.png" align="right" width="230px" style="margin-left: 40px;">
8+
9+
1. Install the repository dependencies (from the project root):
10+
11+
```bash
12+
yarn
13+
```
14+
15+
2. Install the FabricExample app dependencies:
16+
17+
```bash
18+
cd FabricExample
19+
yarn
20+
```
21+
22+
3. Start the Metro server:
23+
24+
```bash
25+
yarn start
26+
```
27+
28+
4. In a separate terminal, build and install the app:
29+
30+
```bash
31+
yarn android
32+
# or
33+
yarn ios
34+
```
35+
36+
## Contributing
37+
38+
If you discovered a bug and know the fix or would like to make a contribution to the project, please check the [contribution guide](../CONTRIBUTING.md).

example/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Example
2+
3+
## Run the app
4+
5+
<img src="../gifs/example-screenshot.png" align="right" width="230px" style="margin-left: 40px;">
6+
7+
1. Install the repository dependencies (from the project root):
8+
9+
```bash
10+
yarn
11+
```
12+
13+
2. Install the example app dependencies:
14+
15+
```bash
16+
cd example
17+
yarn
18+
```
19+
20+
3. Start the Metro server:
21+
22+
```bash
23+
yarn start
24+
```
25+
26+
4. In a separate terminal, build and install the app:
27+
28+
```bash
29+
yarn android
30+
# or
31+
yarn ios
32+
```
33+
34+
## Contributing
35+
36+
If you discovered a bug and know the fix or would like to make a contribution to the project, please check the [contribution guide](../CONTRIBUTING.md).

gifs/example-screenshot.png

185 KB
Loading

0 commit comments

Comments
 (0)