feat: Update example to 3.10.1 and publish readme.

lowdefy · Feb 22, 2021 · 24c7839 · 24c7839
1 parent 33bdc3e
commit 24c7839
Show file tree

Hide file tree

Showing 5 changed files with 99 additions and 52 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+.lowdefy/**
+.env
diff --git a/LICENCE.md b/LICENCE.md
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Lowdefy Inc.
+Copyright (c) 2021 Lowdefy Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,14 +1,29 @@
 # Lowdefy Reporting Example
 
-  This example show patterns that can be used to implement a BI report/dashboard.
+This example demonstrate useful paterns for building a BI report/dashboard pages in Lowdefy. It connects to a MongoDB database with the Atlas Movies sample dataset pre-loaded.
 
-  It assumes that it is connected to a MongoDB database with the Atlas sample dataset loaded.
+Three additional block types is loaded for this examples:
+
+- `AmChartsXY` and `AmChartsPie` from [@lowdefy/blocks-amcharts](https://github.com/lowdefy/blocks-amcharts).
+- `AgGridAlpine`, from [@lowdefy/blocks-aggrid](https://github.com/lowdefy/blocks-aggrid).
 
 ## Running this example
+
+- Create a [MongoDB Atlas](https://www.mongodb.com/try) free tier cluster and select to load the sample dataset.
+- Add a database user to the MongoDB database and generate a connection uri containing the database username and password. Be sure to create the database user with read privileges for the sample database. Read more about using [the Lowdefy MongoDB connector](https://docs.lowdefy.com/MongoDB).
 - Clone this repository.
-- Set up a MongoDB Atlas database and set the connection uri as secret `lowdefy_examples_mdb`.
-- Run the Lowdefy CLI from the cloned repository.
+- Create a `.env` file in your project folder and set your MongoDB database connector URI as a variable in the `.env` file: `LOWDEFY_SECRET_EXAMPLES_MDB="{{ your_mongodb_connection_uri }}"`
+
+- In the command console, navigate to your project folder and run the Lowdefy CLI: `npx lowdefy@latest dev`.
+
+## More Lowdefy resources
+
+- Getting started with Lowdefy - https://docs.lowdefy.com/tutorial-start
+- Lowdefy docs - https://docs.lowdefy.com
+- Lowdefy website - https://lowdefy.com
+- Community forum - https://github.com/lowdefy/lowdefy/discussions
+- Bug reports and feature requests - https://github.com/lowdefy/lowdefy/issues
 
 ## Licence
 
-This example configuration is licensed under the MIT license. See the LICENSE.md file for license rights and limitations.
+[MIT](https://github.com/lowdefy/lowdefy-example-reporting/blob/main/LICENSE)
diff --git a/lowdefy.yaml b/lowdefy.yaml
@@ -1,11 +1,19 @@
 
 name: Lowdefy Reporting Example
-version: 0.0.6
+lowdefy: 3.10.1
 licence: MIT
-description: |
-  This example show patterns that can be used to implement a BI report/dashboard.
 
-  It assumes that it is connected to a MongoDB database with the Atlas sample dataset loaded.
+# description
+# This example show patterns that can be used to implement a BI report/dashboard.
+# It assumes that it is connected to a MongoDB database with the Atlas sample dataset loaded.
+
+types:
+  AmChartsXY:
+    url: https://blocks-cdn.lowdefy.com/v3.10.1/blocks-amcharts/meta/AmChartsXY.json
+  AmChartsPie:
+    url: https://blocks-cdn.lowdefy.com/v3.10.1/blocks-amcharts/meta/AmChartsPie.json
+  AgGridAlpine:
+    url: https://blocks-cdn.lowdefy.com/v3.10.1/blocks-aggrid/meta/AgGridAlpine.json
 
 # Define all the data connections, in this case the brands and products MongoDB collections
 connections:
@@ -15,7 +23,7 @@ connections:
       databaseName: sample_mflix # The database name
       collection: movies # The collection name
       databaseUri:
-        _secret: lowdefy_examples_mdb # The database connection uri that is stored as a secret and accessed using the _secret operator
+        _secret: EXAMPLES_MDB # The database connection uri that is stored as a secret and accessed using the _secret operator
 
 # Menus used in the app can be listed here
 # By default, the menu with id default, or the first menu defined is used.

diff --git a/report.yaml b/report.yaml
@@ -4,7 +4,6 @@ properties:
   title: Report
 layout:
   contentGutter: 16 # Set a gutter of 16px between all the cards on the page
-
 requests:
   # Request for the bar and pie charts
   - id: scores_by_genre
@@ -25,7 +24,7 @@ requests:
                 - Action
         - $group:
             _id: $genres # Group data by the genre field
-              # Calculate the average IMDB, and Rotten Tomatoes viewer and critic ratings for each genre. 
+              # Calculate the average Rotten Tomatoes viewer and critic ratings for each genre. 
             viewerRating:
               $avg: $tomatoes.viewer.rating
             criticRating:
@@ -42,7 +41,7 @@ requests:
             count: -1 # Sort by descending count
 
   # Request for the table
-  - id: top_100_movies
+  - id: top_100_score_difference_movies
     type: MongoDBAggregation # MongoDB Aggregation to get the data
     connectionId: movies_mongodb
     properties:
@@ -82,6 +81,14 @@ requests:
         - $sort:
             difference: -1 # Sort by biggest difference
         - $limit: 100 # Only return the first 100 results
+events:
+  # A list of actions that gets completed when this page is first loaded. 
+  onInitAsync:
+    - id: fetch_data # Fetch the request data before the page renders in order to populate the charts
+      type: Request
+      params: 
+        - scores_by_genre 
+        - top_100_score_difference_movies
 
 blocks:
   - id: title # Title on page
@@ -91,16 +98,13 @@ blocks:
       level: 4
   - id: genre_counts_bar_chart_card
     type: Card
+    properties:
+      title: Comparison of Critic and Viewer Ratings by Genre
     layout:
       span: 16 # Make the card span 2 thirds of the screen
     blocks:
-      - id: title # Add a title
-        type: Markdown
-        properties:
-          content: "#### Comparison of Critic and Viewer Ratings by Genre"
-          level: 4
       - id: genre_counts_bar_chart
-        type: AmCharts4XY # AmCharts4XY is used for all charts with x and y axis
+        type: AmChartsXY # AmCharts4XY is used for all charts with x and y axis
         properties:
           data:
             _request: scores_by_genre # Use scores_by_genre request for chart data
@@ -117,7 +121,7 @@ blocks:
               renderer:
                 grid:
                   disabled: true # Disable vertical grid lines
-                minGridDistance: 20 # Reduce the minimum grid distance so that more category labels can be shown the x axis
+                minGridDistance: 20 # Reduce the minimum grid distance so that more category labels can be shown on the x axis
                 labels: # Rotate the labels
                   contentAlign: right # Align against x axis
                   rotation: -60
@@ -154,14 +158,11 @@ blocks:
     type: Card
     layout:
       span: 8
+    properties:
+      title: Genre Counts
     blocks:
-      - id: title
-        type: Markdown
-        properties:
-          content: "#### Genre Counts"
-          level: 4
       - id: pie_chart
-        type: AmCharts4Pie
+        type: AmChartsPie
         properties:
           height: 400
           data:
@@ -188,20 +189,17 @@ blocks:
                   - '#5A8DF8'
                   - '#7EABFF'
 
-
   - id: table_card
     type: Card
+    properties:
+      title: 100 Movies with Largest Difference between Critic and Viewer Ratings
     blocks:
-      - id: title
-        type: Markdown
-        properties:
-          content: "#### 100 Movies with Largest Difference between Critic and Viewer Ratings"
       - id: table
-        type: AgGrid
+        type: AgGridAlpine
         properties:
           theme: basic
           rowData:
-            _request: top_100_movies
+            _request: top_100_score_difference_movies
           defaultColDef: # Define default column definitions that apply to all the defined columns
             sortable: true # Enables sorting on the columns when the header is clicked
             resizable: true # Enables resizing of column widths
@@ -213,39 +211,63 @@ blocks:
             - headerName: Year
               field: year
               width: 100
+            - headerName: Difference
+              field: difference
+              width: 160
+              type: numericColumn # Setting this aligns the number on the right
+              valueFormatter:
+                _function: # Provide a fprmatter function to pretty render the data value.
+                  __format.intlNumberFormat:
+                    on:
+                      __args: 0.value
+                    params:
+                      options:
+                        minimumFractionDigits: 1 # Format the number with 1 decimal place
             - headerName: Viewer Rating
               field: viewerRating
               width: 160
-              type: numericColumn # Setting this aligns the number on the right
+              type: numericColumn 
               valueFormatter:
-                type: intlNumberFormat # Format the number with 1 decimal place
-                properties:
-                  options:
-                    maximumFractionDigits: 1
+                _function:
+                  __format.intlNumberFormat:
+                    on: 
+                      __args: 0.value
+                    params:
+                      options:
+                        maximumFractionDigits: 1 
             - headerName: Critic Rating
               field: criticRating
               width: 160
               type: numericColumn
               valueFormatter:
-                type: intlNumberFormat
-                properties:
-                  options:
-                    maximumFractionDigits: 1
+                _function:
+                  __format.intlNumberFormat:
+                    on:
+                      __args: 0.value
+                    params:
+                      options:
+                        maximumFractionDigits: 1
             - headerName: Viewer Reviews
               field: viewerReviews
               width: 160
               type: numericColumn
               valueFormatter:
-                type: intlNumberFormat # Format the number with 0 decimal places
-                properties:
-                  options:
-                    maximumFractionDigits: 0
+                _function:
+                  __format.intlNumberFormat:
+                    on: 
+                      __args: 0.value
+                    params:
+                      options:
+                        maximumFractionDigits: 0
             - headerName: Critic Reviews
               field: criticReviews
               width: 160
               type: numericColumn
               valueFormatter:
-                type: intlNumberFormat
-                properties:
-                  options:
-                    maximumFractionDigits: 1
+                _function:
+                  __format.intlNumberFormat:
+                    on: 
+                      __args: 0.value
+                    params:
+                      options:
+                        maximumFractionDigits: 0