Liquid Prep - App

The Liquid Prep App is a user interface that is accessed on your mobile device to receive watering guidance for a selected crop. It is a progressive web app (PWA) developed with an Angular web framework.

The app gets weather and crops data from the Liquid Prep Backend service, and the soil moisture data from the Liquid Prep Hardware. After the analysis of weather, crop and soil moisture data, the app computes and provides water advice for your crop.

The Liquid Prep App can be run on your local machine for development and testing purposes, and is deployed on IBM Cloud Object Storage for production to be accessed globally.

Get Started

Instructions on how to run the app:

• Prerequisites
• Run App Locally
• Configure and Deploy in IBM Cloud Object Storage
• Contributing

Prerequisites

1. Node and NPM:
   • Install Node and NPM
2. Angular CLI
   • Install Angular CLI
3. Git:
   • Install Git
   • Configure Git
   • Git account setup and configuration
4. Liquid Prep project:
   • Git-clone Liquid Prep project
5. IBM Cloud account:
   • Create an IBM Cloud account
6. Liquid Prep Backend Service Endpoint:
   • Deploy Liquid Prep Backend in IBM Cloud Functions and note down the CLOUD_FUNCTIONS_URL which is the Backend service endpoint. This endpoint will be required later for deploying the App.

Run App Locally

1. Build the App

   • Start a terminal/CMD in LiquidPrep-App/liquid-prep-app folder.
   • Run npm install.

2. Config.json

   • In the LiquidPrep-App/liquid-prep-app/src/ folder, rename the file config-sample.json to config.json.
   • Update the config.json with Liquid Prep Backend Service Endpoint noted down in the Pre-requisites 6th point.

3. Run the App

   • Run npm start.
   • Open the browser and enter http://localhost:4200/. The app will automatically reload if you change any of the source files.

   Note: You can also run the app by executing Angular CLI command ng serve.

Configure and Deploy the App in IBM Cloud Object Storage

The Liquid Prep App can be built and deployed in production for accessing the endpoint URL in any browser (we recommend Chrome).

Follow the stepwise instructions in the IBM Cloud Deployment Documentation.

Contributing

For details on our code of conduct, areas where we'd like to see community contributions, and the process for submitting pull requests to the project, see CONTRIBUTING.md.

License

Unless otherwise noted, this project is licensed under the Apache 2 License - see the LICENSE file for details.