Skip to content
This repository was archived by the owner on Apr 8, 2026. It is now read-only.

Commit c2dd335

Browse files
committed
docs(test): update example doc instructions
1 parent 505d9da commit c2dd335

3 files changed

Lines changed: 20 additions & 176 deletions

File tree

example/README.md

Lines changed: 5 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,7 @@
1-
This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli).
1+
Jet Example App
22

3-
# Getting Started
3+
Basic example execution:
44

5-
>**Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding.
6-
7-
## Step 1: Start the Metro Server
8-
9-
First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native.
10-
11-
To start Metro, run the following command from the _root_ of your React Native project:
12-
13-
```bash
14-
# using npm
15-
npm start
16-
17-
# OR using Yarn
18-
yarn start
19-
```
20-
21-
## Step 2: Start your Application
22-
23-
Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the following command to start your _Android_ or _iOS_ app:
24-
25-
### For Android
26-
27-
```bash
28-
# using npm
29-
npm run android
30-
31-
# OR using Yarn
32-
yarn android
33-
```
34-
35-
### For iOS
36-
37-
```bash
38-
# using npm
39-
npm run ios
40-
41-
# OR using Yarn
42-
yarn ios
43-
```
44-
45-
If everything is set up _correctly_, you should see your new app running in your _Android Emulator_ or _iOS Simulator_ shortly provided you have set up your emulator/simulator correctly.
46-
47-
This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
48-
49-
## Step 3: Modifying your App
50-
51-
Now that you have successfully run the app, let's modify it.
52-
53-
1. Open `App.tsx` in your text editor of choice and edit some lines.
54-
2. For **Android**: Press the <kbd>R</kbd> key twice or select **"Reload"** from the **Developer Menu** (<kbd>Ctrl</kbd> + <kbd>M</kbd> (on Window and Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (on macOS)) to see your changes!
55-
56-
For **iOS**: Hit <kbd>Cmd ⌘</kbd> + <kbd>R</kbd> in your iOS Simulator to reload the app and see your changes!
57-
58-
## Congratulations! :tada:
59-
60-
You've successfully run and modified your React Native App. :partying_face:
61-
62-
### Now what?
63-
64-
- If you want to add this new React Native code to an existing application, check out the [Integration guide](https://reactnative.dev/docs/integration-with-existing-apps).
65-
- If you're curious to learn more about React Native, check out the [Introduction to React Native](https://reactnative.dev/docs/getting-started).
66-
67-
# Troubleshooting
68-
69-
If you can't get this to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page.
70-
71-
# Learn More
72-
73-
To learn more about React Native, take a look at the following resources:
74-
75-
- [React Native Website](https://reactnative.dev) - learn more about React Native.
76-
- [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment.
77-
- [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**.
78-
- [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts.
79-
- [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native.
5+
1) Install javascript dependencies: in Jet main directory `yarn && yarn example:install`
6+
1) Install pods: in example directory `rm -f ios/Podfile.lock macos/Podfile.lock && cd ios && pod install cd ../macos/ && pod install && cd ..`
7+
1) `yarn jet --target=<platform>`, use ios, macos, or android for platform

example/macos/Podfile.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ PODS:
44
- FBLazyVector (0.76.5)
55
- fmt (9.1.0)
66
- glog (0.3.5)
7-
- hermes-engine (0.76.6):
8-
- hermes-engine/Pre-built (= 0.76.6)
9-
- hermes-engine/Pre-built (0.76.6)
7+
- hermes-engine (0.76.5):
8+
- hermes-engine/Pre-built (= 0.76.5)
9+
- hermes-engine/Pre-built (0.76.5)
1010
- RCT-Folly (2024.01.01.00):
1111
- boost
1212
- DoubleConversion
@@ -1718,7 +1718,7 @@ SPEC CHECKSUMS:
17181718
FBLazyVector: a19375abbb611b65eaa0ef0659bee9e6b4434f51
17191719
fmt: cca1eb84179ad528ae1ba9fdf135ed1ac49e19cb
17201720
glog: 750f96a379703a2d724d2f1fc6cb3a3eff000817
1721-
hermes-engine: 1949ca944b195a8bde7cbf6316b9068e19cf53c6
1721+
hermes-engine: 06a9c6900587420b90accc394199527c64259db4
17221722
RCT-Folly: 38dded4465d7da30a12a3087110693a6799091d4
17231723
RCTDeprecation: fb7d408617e25d7f537940000d766d60149c5fea
17241724
RCTRequired: bf6c23a8ff555f432eb889852b28797b929b19ca

example/yarn.lock

Lines changed: 11 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -3184,13 +3184,6 @@ __metadata:
31843184
languageName: node
31853185
linkType: hard
31863186

3187-
"ansi-styles@npm:^6.2.1":
3188-
version: 6.2.3
3189-
resolution: "ansi-styles@npm:6.2.3"
3190-
checksum: 10/c49dad7639f3e48859bd51824c93b9eb0db628afc243c51c3dd2410c4a15ede1a83881c6c7341aa2b159c4f90c11befb38f2ba848c07c66c9f9de4bcd7cb9f30
3191-
languageName: node
3192-
linkType: hard
3193-
31943187
"anymatch@npm:^3.0.3":
31953188
version: 3.1.3
31963189
resolution: "anymatch@npm:3.1.3"
@@ -3422,7 +3415,7 @@ __metadata:
34223415
languageName: node
34233416
linkType: hard
34243417

3425-
"babel-plugin-istanbul@npm:^7.0.1":
3418+
"babel-plugin-istanbul@npm:^7.0.0":
34263419
version: 7.0.1
34273420
resolution: "babel-plugin-istanbul@npm:7.0.1"
34283421
dependencies:
@@ -3898,17 +3891,6 @@ __metadata:
38983891
languageName: node
38993892
linkType: hard
39003893

3901-
"cliui@npm:^9.0.1":
3902-
version: 9.0.1
3903-
resolution: "cliui@npm:9.0.1"
3904-
dependencies:
3905-
string-width: "npm:^7.2.0"
3906-
strip-ansi: "npm:^7.1.0"
3907-
wrap-ansi: "npm:^9.0.0"
3908-
checksum: 10/df43d8d1c6e3254cbb64b1905310d5f6672c595496a3cbe76946c6d24777136886470686f2772ac9edfe547a74bb70e8017530b3554715aee119efd7752fc0d9
3909-
languageName: node
3910-
linkType: hard
3911-
39123894
"clone-deep@npm:^4.0.1":
39133895
version: 4.0.1
39143896
resolution: "clone-deep@npm:4.0.1"
@@ -4387,13 +4369,6 @@ __metadata:
43874369
languageName: node
43884370
linkType: hard
43894371

4390-
"emoji-regex@npm:^10.3.0":
4391-
version: 10.6.0
4392-
resolution: "emoji-regex@npm:10.6.0"
4393-
checksum: 10/98cc0b0e1daed1ed25afbf69dcb921fee00f712f51aab93aa1547e4e4e8171725cc4f0098aaa645b4f611a19da11ec9f4623eb6ff2b72314b39a8f2ae7c12bf2
4394-
languageName: node
4395-
linkType: hard
4396-
43974372
"emoji-regex@npm:^8.0.0":
43984373
version: 8.0.0
43994374
resolution: "emoji-regex@npm:8.0.0"
@@ -5297,13 +5272,6 @@ __metadata:
52975272
languageName: node
52985273
linkType: hard
52995274

5300-
"get-east-asian-width@npm:^1.0.0":
5301-
version: 1.4.0
5302-
resolution: "get-east-asian-width@npm:1.4.0"
5303-
checksum: 10/c9ae85bfc2feaf4cc71cdb236e60f1757ae82281964c206c6aa89a25f1987d326ddd8b0de9f9ccd56e37711b9fcd988f7f5137118b49b0b45e19df93c3be8f45
5304-
languageName: node
5305-
linkType: hard
5306-
53075275
"get-intrinsic@npm:^1.2.4, get-intrinsic@npm:^1.2.5, get-intrinsic@npm:^1.2.6, get-intrinsic@npm:^1.2.7":
53085276
version: 1.2.7
53095277
resolution: "get-intrinsic@npm:1.2.7"
@@ -6711,24 +6679,24 @@ __metadata:
67116679

67126680
"jet@file:../package.tgz::locator=io.invertase.testing%40workspace%3A.":
67136681
version: 0.9.0-dev.13
6714-
resolution: "jet@file:../package.tgz#../package.tgz::hash=d2a270&locator=io.invertase.testing%40workspace%3A."
6682+
resolution: "jet@file:../package.tgz#../package.tgz::hash=c767d4&locator=io.invertase.testing%40workspace%3A."
67156683
dependencies:
67166684
"@types/mocha": "npm:^10.0.10"
6717-
babel-plugin-istanbul: "npm:^7.0.1"
6685+
babel-plugin-istanbul: "npm:^7.0.0"
67186686
cosmiconfig: "npm:^9.0.0"
67196687
istanbul-lib-coverage: "npm:^3.2.2"
6720-
mocha: "npm:^11.7.4"
6721-
mocha-remote-client: "npm:^1.13.2"
6722-
mocha-remote-server: "npm:^1.13.2"
6688+
mocha: "npm:^11.1.0"
6689+
mocha-remote-client: "npm:^1.13.0"
6690+
mocha-remote-server: "npm:^1.13.0"
67236691
nyc: "npm:^17.1.0"
6724-
yargs: "npm:^18.0.0"
6692+
yargs: "npm:^17.7.2"
67256693
zod: "npm:^3.24.1"
67266694
peerDependencies:
67276695
react: "*"
67286696
react-native: "*"
67296697
bin:
67306698
jet: ./jet.js
6731-
checksum: 10/b4e32e691f52c89dedb3580838ca917c71845f4cd1ff7fe8e6ed5a21db6cc06bfe9b4bf5bc8a29fbb5429fb48dbc4bb2d748721816185d63e298c660f7f87f8d
6699+
checksum: 10/d593d00a43db2cfc5188924bea445f499f175dd90c424896d9f70eaf7d51ae955c9406203d79031b4ff4dcda6ce5f353588be97b0a2424908e7302c89fd75ce6
67326700
languageName: node
67336701
linkType: hard
67346702

@@ -7587,7 +7555,7 @@ __metadata:
75877555
languageName: node
75887556
linkType: hard
75897557

7590-
"mocha-remote-client@npm:^1.13.2":
7558+
"mocha-remote-client@npm:^1.13.0":
75917559
version: 1.13.2
75927560
resolution: "mocha-remote-client@npm:1.13.2"
75937561
dependencies:
@@ -7608,7 +7576,7 @@ __metadata:
76087576
languageName: node
76097577
linkType: hard
76107578

7611-
"mocha-remote-server@npm:^1.13.2":
7579+
"mocha-remote-server@npm:^1.13.0":
76127580
version: 1.13.2
76137581
resolution: "mocha-remote-server@npm:1.13.2"
76147582
dependencies:
@@ -7620,7 +7588,7 @@ __metadata:
76207588
languageName: node
76217589
linkType: hard
76227590

7623-
"mocha@npm:^11.7.4":
7591+
"mocha@npm:^11.1.0":
76247592
version: 11.7.4
76257593
resolution: "mocha@npm:11.7.4"
76267594
dependencies:
@@ -9408,17 +9376,6 @@ __metadata:
94089376
languageName: node
94099377
linkType: hard
94109378

9411-
"string-width@npm:^7.0.0, string-width@npm:^7.2.0":
9412-
version: 7.2.0
9413-
resolution: "string-width@npm:7.2.0"
9414-
dependencies:
9415-
emoji-regex: "npm:^10.3.0"
9416-
get-east-asian-width: "npm:^1.0.0"
9417-
strip-ansi: "npm:^7.1.0"
9418-
checksum: 10/42f9e82f61314904a81393f6ef75b832c39f39761797250de68c041d8ba4df2ef80db49ab6cd3a292923a6f0f409b8c9980d120f7d32c820b4a8a84a2598a295
9419-
languageName: node
9420-
linkType: hard
9421-
94229379
"string.prototype.matchall@npm:^4.0.12":
94239380
version: 4.0.12
94249381
resolution: "string.prototype.matchall@npm:4.0.12"
@@ -9524,15 +9481,6 @@ __metadata:
95249481
languageName: node
95259482
linkType: hard
95269483

9527-
"strip-ansi@npm:^7.1.0":
9528-
version: 7.1.2
9529-
resolution: "strip-ansi@npm:7.1.2"
9530-
dependencies:
9531-
ansi-regex: "npm:^6.0.1"
9532-
checksum: 10/db0e3f9654e519c8a33c50fc9304d07df5649388e7da06d3aabf66d29e5ad65d5e6315d8519d409c15b32fa82c1df7e11ed6f8cd50b0e4404463f0c9d77c8d0b
9533-
languageName: node
9534-
linkType: hard
9535-
95369484
"strip-bom@npm:^4.0.0":
95379485
version: 4.0.0
95389486
resolution: "strip-bom@npm:4.0.0"
@@ -10176,17 +10124,6 @@ __metadata:
1017610124
languageName: node
1017710125
linkType: hard
1017810126

10179-
"wrap-ansi@npm:^9.0.0":
10180-
version: 9.0.2
10181-
resolution: "wrap-ansi@npm:9.0.2"
10182-
dependencies:
10183-
ansi-styles: "npm:^6.2.1"
10184-
string-width: "npm:^7.0.0"
10185-
strip-ansi: "npm:^7.1.0"
10186-
checksum: 10/f3907e1ea9717404ca53a338fa5a017c2121550c3a5305180e2bc08c03e21aa45068df55b0d7676bf57be1880ba51a84458c17241ebedea485fafa9ef16b4024
10187-
languageName: node
10188-
linkType: hard
10189-
1019010127
"wrappy@npm:1":
1019110128
version: 1.0.2
1019210129
resolution: "wrappy@npm:1.0.2"
@@ -10327,13 +10264,6 @@ __metadata:
1032710264
languageName: node
1032810265
linkType: hard
1032910266

10330-
"yargs-parser@npm:^22.0.0":
10331-
version: 22.0.0
10332-
resolution: "yargs-parser@npm:22.0.0"
10333-
checksum: 10/f13c42bad6ebed1a587a72f2db5694f5fa772bcaf409a701691d13cf74eb5adfcf61a2611de08807e319b829d3e5e6e1578b16ebe174cae8e8be3bf7b8e7a19e
10334-
languageName: node
10335-
linkType: hard
10336-
1033710267
"yargs-unparser@npm:^2.0.0":
1033810268
version: 2.0.0
1033910269
resolution: "yargs-unparser@npm:2.0.0"
@@ -10380,20 +10310,6 @@ __metadata:
1038010310
languageName: node
1038110311
linkType: hard
1038210312

10383-
"yargs@npm:^18.0.0":
10384-
version: 18.0.0
10385-
resolution: "yargs@npm:18.0.0"
10386-
dependencies:
10387-
cliui: "npm:^9.0.1"
10388-
escalade: "npm:^3.1.1"
10389-
get-caller-file: "npm:^2.0.5"
10390-
string-width: "npm:^7.2.0"
10391-
y18n: "npm:^5.0.5"
10392-
yargs-parser: "npm:^22.0.0"
10393-
checksum: 10/5af36234871390386b31cac99f00e79fcbc2ead858a61b30a8ca381c5fde5df8af0b407c36b000d3f774bcbe4aec5833f2f1c915f6ddc49ce97b78176b651801
10394-
languageName: node
10395-
linkType: hard
10396-
1039710313
"yocto-queue@npm:^0.1.0":
1039810314
version: 0.1.0
1039910315
resolution: "yocto-queue@npm:0.1.0"

0 commit comments

Comments
 (0)