Merge pull request #1041 from Chia-Network/develop

Release 1.0.19

Author: TheLastCicada

.github/workflows/build-installers.yaml

@@ -23,10 +23,10 @@ jobs:
       - uses: Chia-Network/actions/clean-workspace@main
 
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v3
 
       - name: Setup Node 16.x
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v3
         with:
           node-version: '16.x'
 
@@ -39,7 +39,7 @@ jobs:
           npm install
 
       - name: Import Apple installer signing certificate
-        uses: Apple-Actions/import-codesign-certs@v1
+        uses: Apple-Actions/import-codesign-certs@v1
         with:
           p12-file-base64: ${{ secrets.APPLE_DEV_ID_APP }}
           p12-password: ${{ secrets.APPLE_DEV_ID_APP_PASS }}
@@ -60,7 +60,7 @@ jobs:
             --password "${{ secrets.APPLE_NOTARIZE_PASSWORD }}"
 
       - name: Upload Mac Installer
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v3
         with:
           name: mac-installer
           path: ${{ github.workspace }}/dist/*.dmg
@@ -70,10 +70,10 @@ jobs:
     runs-on: windows-2019
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v3
 
       - name: Setup Node 16.x
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v3
         with:
           node-version: '16.x'
 
@@ -89,7 +89,7 @@ jobs:
         run: npm run electron:package:win
 
       - name: Upload Windows Installer
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v3
         with:
           name: windows-installer
           path: ${{ github.workspace }}/dist/*.exe
@@ -99,10 +99,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v3
 
       - name: Setup Node 16.x
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v3
         with:
           node-version: '16.x'
 
@@ -115,7 +115,7 @@ jobs:
         run: npm run electron:package:linux
 
       - name: Upload Linux Installer
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v3
         with:
           name: linux-installer
           path: ${{ github.workspace }}/dist/*.deb
@@ -125,10 +125,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v3
 
       - name: Setup Node 16.x
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v3
         with:
           node-version: '16.x'
 
@@ -142,7 +142,7 @@ jobs:
         run: tar -cvzf web-build.tar.gz build
 
       - name: Upload build artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v3
         with:
           name: web-build
           path: web-build.tar.gz
@@ -157,25 +157,25 @@ jobs:
       - build_web
     steps:
       - name: Download Windows artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v3
         with:
           name: windows-installer
           path: windows-installer
 
       - name: Download MacOS artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v3
         with:
           name: mac-installer
           path: mac-installer
 
       - name: Download Linux artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v3
         with:
           name: linux-installer
           path: linux-installer
 
       - name: Download Web artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v3
         with:
           name: web-build
           path: web-build
@@ -193,7 +193,7 @@ jobs:
           echo "WEB_FILE=$WEB_FILE" >>$GITHUB_ENV
 
       - name: Release
-        uses: softprops/[email protected]
+        uses: softprops/[email protected].15
         with:
           files: |
             ${{ env.DMG_FILE }}

README.md

@@ -1,10 +1,23 @@
-# Climate Warehouse Auxillery App
+# Climate Warehouse User Interface
 
-Auxillery App for the Climate Warehouse
+This repository provides a graphical user interface (UI) for the [Climate Warehouse](https://github.com/Chia-Network/climate-warehouse) application.  The Climate Warehouse interfaces with the Chia Blockchain software and provides and API for entering and retrieving carbon data.  This UI is a javascript application that connects to the Climate Warehouse API for a convenient way to access the data. 
 
-## Quickstart
 
-### Installation
+## Installation
+
+The UI application can be hosted as a web application and accessed via the browser, or as a desktop application packaged with Electron. 
+
+### Desktop Applications
+
+The [releases](https://github.com/Chia-Network/climate-warehouse-ui/releases) page provides desktop applications packaged for Windows, Mac, and Debian-based Linux distributions.  
+
+### Web Application
+
+The Climate Warehouse UI can be hosted as a web application, either for internal use, or made available to the public.  When operating as a web application, the user's browser must be able to connect to the [Climate Warehouse API](https://github.com/Chia-Network/climate-warehouse).  This means the API must be available on the public internet if the UI is public.  The `READ_ONLY` option on the API should be set when running a public observer node. 
+
+To host the UI on the web, use the [web-build.tar.gz file from the releases page](https://github.com/Chia-Network/climate-warehouse-ui/releases). One of the simplest solutions is to uncompress these files into a [public S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/WebsiteAccessPermissionsReqd.html). These files could also be served by any webserver, such as Nginx or Apache.  
+
+### From Source
 
 ```
 npm install -g react-scripts
@@ -27,7 +40,7 @@ chmod ug+x .git/hooks/*
 npm run start
 ```
 
-### Prerequisites
+#### Prerequisites
 
 You'll need:
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "climate-action-data-trust",
-  "version": "1.0.20",
+  "version": "1.0.19",
   "private": true,
   "author": "Chia Network Inc. <[email protected]>",
   "homepage": "./",