Updates prior to releasing SDK to customer

Author: Michael Wilkerson-Barker

README.md

@@ -1,2 +1,42 @@
 # test-app-flutter
 Refactored Flutter Template App that allows for switching between the cloud and edge servers.
+
+## How to set up
+
+1. Download this repo to a local directory
+2. Download and extract the contents of the flutter "update base URL" SDK archive into a
+   `flutter-update-baseurl` directory under the same parent directory where this repo is stored.
+3. Open the pubspec.yaml file and verify the realm dependency path points to your directory where
+   the SDK was extracted:
+
+```
+  realm:
+    path: ../flutter-update-baseurl/realm
+```
+
+4. Start up the edge server using the instructions online and the provided `config.json` file in
+   the _edge/_ directory. This points to a demo Realm app that can be used with this demo app.
+
+**IMPORTANT:** Only one Edge Server instance can be running at a time with the provided `config.json`
+file.
+
+5. Update the `edgeServer` constant in _lib/realm/realm\_services.dart_ file to point to the
+   hostname or ip address of the edge server started in step 4.
+6. Update the flutter app dependencies by running `flutter pub get` from the top level
+   _test-app-flutter/_ directory.
+
+## Running the Demo App
+
+1. Start the flutter app by running `flutter run`.
+2. Log in using a new user or the default user credentials:
+
+> username: `testuser4@test.com`
+
+> password: `testpass`
+
+3. The "cloud" button in the App Bar will switch between the cloud (filled) or edge (circle)
+   servers and the list will be updated with the contents from that server. The confirmation
+   of the server used will be printed on the command line.
+4. Verify everything is working properly by using the offline/online (Wifi) button in the
+   App Bar or using the "Show All Tasks" switch. The command line will show information
+   about when either of these items is selected or changed.

edge/config.json

@@ -0,0 +1,15 @@
+{
+  "clientAppId": "devicesync-bmqjg",
+  "query": "*",
+  "cloudSyncServerAuthSecret": "964d3b768c1e16b6a74463191ec6b1b8",
+  "hostname": "localhost",
+  "tls" : {
+    "enabled": false,
+    "certificates": [
+      {
+        "publicKeyPath": "certs/cert.pem",
+        "privateKeyPath": "certs/certkey.pem"
+      }
+    ]
+  }
+}

pubspec.lock

@@ -499,21 +499,21 @@ packages:
   realm:
     dependency: "direct main"
     description:
-      path: "/Users/michael.wilkersonbarker/Dev/realm-dart-lib/release-bundle-1/realm"
-      relative: false
+      path: "../flutter-update-baseurl/realm"
+      relative: true
     source: path
     version: "1.6.1-aa08922819602035b653c72d5cf5b26d42881fee"
   realm_common:
     dependency: transitive
     description:
-      path: "../realm-dart-lib/release-bundle-1/common"
+      path: "../flutter-update-baseurl/common"
       relative: true
     source: path
     version: "1.6.1-aa08922819602035b653c72d5cf5b26d42881fee"
   realm_generator:
     dependency: transitive
     description:
-      path: "../realm-dart-lib/release-bundle-1/generator"
+      path: "../flutter-update-baseurl/generator"
       relative: true
     source: path
     version: "1.6.1-aa08922819602035b653c72d5cf5b26d42881fee"

pubspec.yaml

@@ -15,7 +15,7 @@ dependencies:
   provider: ^6.0.0
   # realm: ^1.4.0
   realm:
-    path: ../realm-dart-lib/release-bundle-1/realm
+    path: ../flutter-update-baseurl/realm
   path_provider: ^2.0.10
   url_launcher: ^6.1.12