Added the latest changes for monorepo and wrote README

Author: hemish11

README.md

@@ -1 +1,57 @@
-TODO Add it
+# Ensemble
+
+Welcome to the Ensemble! This repository houses the Flutter runtime, various modules, and an example app called the Starter App that utilizes different packages. Ensemble allows you to build, publish, and iterate native and web apps seamlessly within your browser.
+
+## What is Ensemble?
+
+Ensemble is a revolutionary platform that enables app development through a declarative language. Rather than traditional coding, you configure your app using this language, allowing for rapid development and deployment. Key features of Ensemble include:
+
+- **Native Experience:** Ensemble apps are native to each platform - iOS, Android, and web.
+- **Instant Updates:** App definitions are pushed to clients, enabling instant updates without waiting for app store approvals.
+- **Cutting-Edge Technologies:** Ensemble apps leverage the latest front-end technologies, such as Flutter for iOS and Android, and React for web, ensuring you're always at the forefront without worrying about technical debt.
+
+## Modules
+
+This monorepo contains the following modules:
+
+- **Auth Module:** Handles authentication functionalities.
+- **Bracket Module:** Manages brackets for various purposes.
+- **Camera Module:** Provides camera-related features.
+- **Connect Module:** Facilitates connectivity features.
+- **Contacts Module:** Manages contact information.
+- **Deeplink Module:** Handles deep linking functionalities.
+- **File Manager Module:** Manages files within the app.
+- **Firebase Analytics Module:** Integrates Firebase analytics into Ensemble apps.
+
+## Starter App
+
+The Starter App, located in the `example` folder, serves as a demonstration of how to integrate and use different packages within Ensemble. It showcases the capabilities of Ensemble and how its modules can be utilized to create powerful applications.
+
+## Links
+
+- [Ensemble Website](https://ensembleui.com/)
+- [Ensemble Docs](https://docs.ensembleui.com/#/)
+- [Ensemble Studio](https://studio.ensembleui.com/)
+- [Ensemble Go (App Store)](https://testflight.apple.com/join/yFKnLQ1S)
+- [Ensemble Preview (Play Store)](https://play.google.com/store/apps/details?id=com.ensembleui.preview)
+
+## Melos Integration
+
+This monorepo is managed using [Melos](https://melos.invertase.dev/), a tool for managing Dart and Flutter monorepos. Below are some useful commands:
+
+- **Initialize Melos:** `melos bootstrap` - Initializes the monorepo and installs dependencies.
+- **Add Dependency:** `melos add` - Add a dependency to one or more packages.
+- **Run Scripts:** `melos exec` - Run a script in each package.
+- **Publish Packages:** `melos release` - Publishes changed packages.
+
+## How to Contribute
+
+To contribute a new widget or enhance an existing one in Ensemble, follow these steps:
+
+1. All Ensemble widgets can be found [here](https://github.com/EnsembleUI/ensemble/tree/main/lib/widget).
+2. Run the Kitchen Sink app locally by visiting [this link](https://studio.ensembleui.com/app/e24402cb-75e2-404c-866c-29e6c3dd7992/screens) and use the appId as described above.
+3. Explore how each widget works and how the YAML is mapped to the Flutter widget.
+4. Create your own app and screens with your widget (or enhanced widget) in the studio. Ensure it works flawlessly.
+5. When ready, create a pull request, and our team will review and provide feedback.
+
+Thank you for contributing to Ensemble! 🚀

examples/starter/README.md

@@ -13,7 +13,8 @@ This starter project enables running and deploying Ensemble-powered Apps across
 - Run `flutter create --org com.ensembleui --project-name starter --platform=ios,android,web .` (note the period at the end). If you modified the appId, make sure the org and project name match the bundle ID.
 - Run `flutter pub upgrade`. Run this occasionally when the Ensemble framework has been updated.
 - Run the App with `flutter run`. If you currently have a running iOS or Android emulator, the command will prompt for a selection, otherwise the App will be opened in the web browser.
-- This will run the `helloApp` packaged with this repo. You can package your app locally, or hosted them on your own server or on Ensemble-hosted server. 
+- This will run the `Ensemble Kitchen Sink` app. This app is available as a demo app in Ensemble Studio.
+- Optionally, you can package your app locally, or hosted them on your own server or on Ensemble-hosted server. 
 
 ### Modules
 By default, Starter does not include all the modules or capabilities (e.g. camera, location). Excluding these capabilities by default reduces the App's size and not trigger any red flags during your App Store Review (e.g. camera code is present when your app doesn't use camera). Please follow the below steps carefully if your app requires these capabilities:
@@ -58,8 +59,16 @@ Ensemble Studio includes an Online Editor for making changes with type-ahead sup
 - Follow [iOS](https://docs.flutter.dev/deployment/ios), [Android](https://docs.flutter.dev/deployment/android), [MacOS](https://docs.flutter.dev/deployment/macos), [Windows](https://docs.flutter.dev/deployment/windows) release documentation.
 
 ## Misc
-### Run with remote definition (to be continued)
+### Run with remote definition
 To take advantage of Server-driven UI (change your UI at anytime from the server), you can host these definitions on your file server.
+When hosting on your server, follow the following steps. 
+
+- in ensemble/ensemble-config.yaml - specify `from: remote` under `definitions`
+- then change the `remote:` settings to match your server's configuration
+- make sure that your server is configured to serve files with extension `.ensemble` with `text/yaml` mime-type.
+- lastly if you are running `flutter run` with web configuration locally, make sure your webserver is properly configured to avoid CORS issues. See `custom_http_server.py` for an example
+
+- You can also use the sample python server script to test it out locally, see `custom_http_server.py` and run it as `python3 custom_http_server.py` from command prompt. 
 
 ### For Flutter developers
 Use [Android Studio](https://developer.android.com/studio) to open this project and run `main.dart`.

examples/starter/custom_http_server.py

@@ -0,0 +1,25 @@
+import http.server
+from http.server import HTTPServer, SimpleHTTPRequestHandler
+import mimetypes
+
+class CustomHTTPRequestHandler(SimpleHTTPRequestHandler):
+    def guess_type(self, path):
+        if path.endswith('.ensemble'):
+            return 'text/yaml'
+        return super().guess_type(path)
+
+    def end_headers(self):
+        self.send_header('Access-Control-Allow-Origin', '*')
+        self.send_header('Access-Control-Allow-Methods', 'GET, POST, OPTIONS')
+        self.send_header('Access-Control-Allow-Headers', 'X-Requested-With')
+        self.send_header('Access-Control-Allow-Headers', 'Content-Type')
+        super().end_headers()
+
+if __name__ == '__main__':
+    PORT = 8000
+    handler = CustomHTTPRequestHandler
+    httpd = HTTPServer(("", PORT), handler)
+
+    print(f"Serving at port {PORT}")
+    httpd.serve_forever()
+

examples/starter/ensemble/apps/helloApp/Hello Home.yaml

@@ -1,15 +1,47 @@
+Import:
+  - utils
+  - common
+
 View:
+  # Optional - style the screen
   styles:
-    useSafeArea: true
+    scrollableView: true
+
+  # Optional - set the header for the screen
+  header:
+    title: Home
+  onLoad: |
+    saveName('John','Doe');
+    console.log('name is ='+getName());
+
+  # Specify the body of the screen
   body:
-    # show 2 widgets vertically
     Column:
+      styles:
+        padding: 24
+        gap: 8
       children:
-        # widget displaying a text
         - Text:
-            text: Welcome
-
-        # reference a reusable widget defined in resources.ensemble
+            text: Hello ${ensemble.storage.helloApp.name.first} ${ensemble.storage.helloApp.name.last}
         - MyCustomWidget1:
             inputs:
-              name: Peter Parker
+              inputName: ${ensemble.storage.helloApp.name}
+        - Button:
+            label: Call API in imported library
+            onTap: |-
+              callMockMethod();
+              console.log('name is ='+getName());  
+
+
+Global: |-
+  //var myVar = myButton.label;
+  function globalHello() {
+    console.log('hello');
+  }
+
+API:
+  mockAPI:
+    url: https://dummyjson.com/users/1
+    method: GET
+    onResponse: |-
+      saveName('Michael', 'Jordan');

examples/starter/ensemble/apps/helloApp/resources.ensemble

@@ -1,14 +1,50 @@
 Widgets:
-  # this widget can be referenced using ensemble.MyCustomWidget1
+  # this widget can be referenced using MyCustomWidget1
   MyCustomWidget1:
+    Import:
+      - apiUtils
+      - common
     inputs:
-      - name
+      - inputName
     body:
-      Text:
-        text: Hello ${name} !
-
-  # another widget
+      Column:
+        children:
+          - Text:
+              text: ${inputName.first} ${inputName.last}
+          - Button:
+              label: sayHello in console
+              onTap: |-
+                saveName('Jane','Doe');
+                console.log('name:'+getName());
+          - MyCustomWidget2:
+              inputs:
+                customProperty: ${ensemble.storage.helloApp.name.first}
   MyCustomWidget2:
+    inputs:
+      - customProperty
     body:
-      Text:
-        text: hello world
+      Column:
+        children:
+          - Text:
+              text: ${customProperty}
+
+Scripts:
+  utils: |-
+    var apiUtilsCount = 0;
+    function callMockMethod() {
+      apiUtilsCount++;
+      console.log('apiUtilsCount='+apiUtilsCount);
+    }
+  common: |-
+    function sayHello(name) {
+      console.log('sayHello:'+name);
+    }
+    function saveName(first,last) {
+      ensemble.storage.helloApp = {name: {first: first, last: last}};
+    }
+    function getName() {
+      if ( ensemble.storage.helloApp != null ) {
+        return ensemble.storage.helloApp.name;
+      }
+      return null;
+    }

examples/starter/ensemble/ensemble-config.yaml

@@ -1,6 +1,6 @@
 definitions:
   # where your page definitions are hosted ('local', 'remote' or 'ensemble')
-  from: local
+  from: ensemble
 
   # for embedding definitions locally in your Flutter App
   local:
@@ -16,31 +16,25 @@ definitions:
 
   # for hosting definitions on your own server
   remote:
+    # the path to your app on your remote server. For example - http://localhost:8000/
     path: <your_http_server_hosting_the_definitions>
     appId: helloApp
     appHome: Hello Home
+    # path to your i18n (translation files) dir. If you are not using translations, just point to the one that comes with this repo. Example - http://localhost:8000/i18n 
     i18nPath: <full_url_including_scheme_and_host_to_i18n_directory_on_your_server>
 
   # for Ensemble-hosted definitions, simply enter your Ensemble's app key
   ensemble:
-    # appId can be found on Ensemble Studio.
-    appId: <my app id on studio.ensembleui.com>
+    # appId can be found on Ensemble Studio. Navigate to your app, click the menu icon on top right, and copy your appId
+    # here is the appId for Ensemble Kitchen sink. You can view this app under demo apps in studio.
+    appId: e24402cb-75e2-404c-866c-29e6c3dd7992
     i18nPath: https://raw.githubusercontent.com/EnsembleUI/starter/main/ensemble/i18n
 
-  # for legacy Ensemble-hosted definitions, simply enter your Ensemble's app key
-  legacy:
-    # this is the Ensemble server URL. Do not change
-    path: https://pz0mwfkp5m.execute-api.us-east-1.amazonaws.com/dev
-    # appId can be found on Ensemble Studio.
-    appId: <my app id>
-    i18nPath: https://raw.githubusercontent.com/EnsembleUI/starter/main/ensemble/i18n
-    enableCache: false
-
 i18n:
   #locale string e.g. en, nl etc. If empty, user's device locale is used
-  defaultLocale: nl
+  defaultLocale: en
   #if strings in defaultLocale are not found, which locale to use instead
-  fallbackLocale: en
+  fallbackLocale: nl
   #use country code after locale code such as en_us
   useCountryCode: false
 
@@ -76,10 +70,6 @@ services:
         redirectUri: msauth.com.ensembleui.starter://auth
         redirectScheme: msauth.com.ensembleui.starter
 
-# Legacy Maps, replace with your own keys
-accounts:
-  maps:
-    mapbox_access_token: pk.eyJ1IjoiZW5zZW1ibGV1aSIsImEiOiJjbDVsYTNoeDQwaGQwM21udzhyemR3cDJrIn0.dnn3x8nZVj5ZFO3tn5l8Ww
 
 # override any environment variables on studio.ensembleui.com here
 # e.g. load local assets instead of URL
@@ -90,3 +80,23 @@ environmentVariables:
   # This asset value is empty, meaning a reference of {env.exampleAssetVariable}pic.png
   # will be loaded locally from /ensemble/assets/pic.png
   exampleAssetVariable:
+
+# uncomment the following when using firebase analytics.
+# For iOS - Make sure that GoogleService-Info.plist is placed under the ios/Runner folder AND has been added to the Xcode project. Just putting the file under Runner folder is NOT sufficient, it has to be added to the prject using Xcode.
+# For Android - Make sure that google-services.json is placed under android/app folder
+# For Web - make sure that the web config is present under account/firebase/web below.
+#analytics:
+#  provider: firebase
+#  enabled: true
+#  enableConsoleLogs: true
+# uncomment the following when using Firebase analytics for the Web and replace the values with the values from your Firebase app.
+#accounts:
+#  firebase:
+#    web:
+#      apiKey: "xxxxx"
+#      authDomain: "xxxxx"
+#      projectId: "xxxx"
+#      storageBucket: "xxxxx"
+#      messagingSenderId: "nnnnnn"
+#      appId: "n:xxxxxxx"
+#      measurementId: "G-xxxxx"

examples/starter/ios/Podfile

@@ -1,5 +1,5 @@
 # Uncomment this line to define a global platform for your project
-platform :ios, '12.0'
+platform :ios, '13.0'
 
 # CocoaPods analytics sends network stats synchronously affecting flutter build latency.
 ENV['COCOAPODS_DISABLE_STATS'] = 'true'
@@ -32,7 +32,7 @@ target 'Runner' do
   use_modular_headers!
 
   flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
-  pod 'FirebaseFirestore', :git => 'https://github.com/invertase/firestore-ios-sdk-frameworks.git', :tag => '10.15.0'
+  pod 'FirebaseFirestore', :git => 'https://github.com/invertase/firestore-ios-sdk-frameworks.git', :tag => '10.22.0'
   target 'RunnerTests' do
     inherit! :search_paths
   end

examples/starter/ios/Runner/AppDelegate.swift

@@ -1,6 +1,7 @@
 import UIKit
 import Flutter
-import GoogleMaps
+// import GoogleMaps
+import flutter_local_notifications
 
 @UIApplicationMain
 @objc class AppDelegate: FlutterAppDelegate {
@@ -13,7 +14,14 @@ import GoogleMaps
   ) -> Bool {
     let controller : FlutterViewController = window?.rootViewController as! FlutterViewController
     methodChannel =  FlutterMethodChannel(name: AppDelegate.methodChannelName, binaryMessenger: controller.binaryMessenger)
-    GMSServices.provideAPIKey("AIzaSyD8vwvoaEPEgYemp1EkIETetJMvyS4Ptqk")
+//     GMSServices.provideAPIKey("AIzaSyD8vwvoaEPEgYemp1EkIETetJMvyS4Ptqk")
+    FlutterLocalNotificationsPlugin.setPluginRegistrantCallback { (registry) in
+                GeneratedPluginRegistrant.register(with: registry) }
+
+    if #available(iOS 10.0, *) {
+      UNUserNotificationCenter.current().delegate = self as UNUserNotificationCenterDelegate
+    }
+    
     GeneratedPluginRegistrant.register(with: self)
     return super.application(application, didFinishLaunchingWithOptions: launchOptions)
   }