Skip to content

Commit

Permalink
Include macOS details in README
Browse files Browse the repository at this point in the history
  • Loading branch information
blefebvre committed Jan 26, 2021
1 parent 62f7d9f commit e152b74
Showing 1 changed file with 29 additions and 16 deletions.
45 changes: 29 additions & 16 deletions README.md
@@ -1,8 +1,8 @@
# React Native SQLite + Dropbox sync demo

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.
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.

These instructions only cover iOS usage at this time.
These instructions cover iOS and macOS usage at this time.


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


## Install macOS dependencies

pushd macos/
pod install
popd


## Start the React Native Metro Bundler

npm start
npm run start:macos


## Compile TypeScript source in watch mode
## Run (and debug) on the iOS simulator

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

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.

## Run the Jest tests in watch mode
Alternatively:

npm test
open ios/RNSQLiteDemo.xcworkspace

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

## Open the source in VS Code
## Run on the macOS simulator

code .
Open the macOS Xcode project:

open macos/RNSQLiteDemo.xcworkspace/

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

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

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.
## Types and testing

Alternatively:
### Compile TypeScript source in watch mode

open ios/RNSQLiteDemo.xcworkspace
npm run tsc -- -w


### Run the Jest unit tests

npm test

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

## E2E Testing with Detox
### E2E Testing with Detox on iOS

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

Expand Down

0 comments on commit e152b74

Please sign in to comment.