Skip to content

Commit e152b74

Browse files
committed
Include macOS details in README
1 parent 62f7d9f commit e152b74

File tree

1 file changed

+29
-16
lines changed

1 file changed

+29
-16
lines changed

README.md

Lines changed: 29 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# React Native SQLite + Dropbox sync demo
22

3-
This project is a basic List application that demonstrates building an offline first app with SQLite and React Native (featuring TypeScript and CocoaPods under the hood). Once authorized, the database can be synced between multiple devices using Dropbox.
3+
This project is a basic List application that demonstrates building an offline first app with SQLite and React Native (featuring TypeScript and CocoaPods under the hood). Once authorized, the database can be synced between multiple iOS devices using Dropbox.
44

5-
These instructions only cover iOS usage at this time.
5+
These instructions cover iOS and macOS usage at this time.
66

77

88
## Install JS dependencies
@@ -17,39 +17,52 @@ These instructions only cover iOS usage at this time.
1717
popd
1818

1919

20+
## Install macOS dependencies
21+
22+
pushd macos/
23+
pod install
24+
popd
25+
26+
2027
## Start the React Native Metro Bundler
2128

22-
npm start
29+
npm run start:macos
2330

2431

25-
## Compile TypeScript source in watch mode
32+
## Run (and debug) on the iOS simulator
2633

27-
npm run tsc -- -w
34+
With the "React Native Tools" VSCode extension installed, open the Debug tab and press the "Play" button with "Debug iOS" selected in the dropdown.
2835

36+
When the simulator opens, press Command-D to open the developer menu. Tap "Debug JS Remotely" to connect VSCode to the app and enable debugging.
2937

30-
## Run the Jest tests in watch mode
38+
Alternatively:
3139

32-
npm test
40+
open ios/RNSQLiteDemo.xcworkspace
3341

42+
Select a simulator of your choice. Press the "run" button.
3443

35-
## Open the source in VS Code
44+
## Run on the macOS simulator
3645

37-
code .
46+
Open the macOS Xcode project:
3847

48+
open macos/RNSQLiteDemo.xcworkspace/
3949

40-
## Run (and debug) on an iOS simulator
50+
Select `My Mac` as the "active scheme". Press the "Build and then run" (Play) button.
4151

42-
With the "React Native Tools" VSCode extension installed, open the Debug tab and press the "Play" button with "Debug iOS" selected in the dropdown.
4352

44-
When the simulator opens, press Command-D to open the developer menu. Tap "Debug JS Remotely" to connect VSCode to the app and enable debugging.
53+
## Types and testing
4554

46-
Alternatively:
55+
### Compile TypeScript source in watch mode
4756

48-
open ios/RNSQLiteDemo.xcworkspace
57+
npm run tsc -- -w
58+
59+
60+
### Run the Jest unit tests
61+
62+
npm test
4963

50-
Select a simulator of your choice. Press the "run" button.
5164

52-
## E2E Testing with Detox
65+
### E2E Testing with Detox on iOS
5366

5467
End-to-end testing happens from within the `e2e/` directory:
5568

0 commit comments

Comments
 (0)