Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@

[![Click](https://img.shields.io/badge/Click-Liquid%20%20Prep%20App-blue)](https://liquid-prep-app.s3-web.us-east.cloud-object-storage.appdomain.cloud/)

Liquid Prep App is an user interface that is accessed on your mobile device to get water advise for the selected crop. It is a [Progressive Web App (PWA)](https://web.dev/progressive-web-apps/) developed with [Angular](https://angular.io/) web framework.
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)](https://web.dev/progressive-web-apps/) developed with an [Angular](https://angular.io/) web framework.

The Liquid Prep App gets the Weather and Crops data from the [Liquid Prep Backend](https://github.com/Liquid-Prep/LiquidPrep-Backend) service and the soil moisture data from the [Liquid Prep Hardware](https://github.com/Liquid-Prep/LiquidPrep-Hardware). After analysis of the weather, crop and soil moisture data the app computes and provides water advise for the selected crop.
The app gets weather and crops data from the [Liquid Prep Backend](https://github.com/Liquid-Prep/LiquidPrep-Backend) service, and the soil moisture data from the [Liquid Prep Hardware](https://github.com/Liquid-Prep/LiquidPrep-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 purpose. And it is deployed on [IBM Cloud Object Storage](https://www.ibm.com/ca-en/cloud/object-storage) for production to be accessed globally.
The Liquid Prep App can be run on your local machine for development and testing purposes, and is deployed on [IBM Cloud Object Storage](https://www.ibm.com/ca-en/cloud/object-storage) for production to be accessed globally.

**[Click to access Liquid Prep App](https://liquid-prep-app.s3-web.us-east.cloud-object-storage.appdomain.cloud/)**

## Get Started

Instructions on how to run the App,
Instructions on how to run the app:

- [Pre-requisites](#pre-requisites)
- [Prerequisites](#pre-requisites)
- [Run App Locally](#run-app-locally)
- [Configure and Deploy App in IBM Cloud Object Storage](#configure-and-deploy-app-in-ibm-cloud-object-storage)
- [Configure and Deploy in IBM Cloud Object Storage](#configure-and-deploy-app-in-ibm-cloud-object-storage)
- [Contributing](#contributing)

### Pre-requisites
### Prerequisites

1. Node and NPM:
- [Install Node and NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
Expand All @@ -30,7 +30,7 @@ Instructions on how to run the App,
- [Configure Git](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup)
- [Git account setup and configuration](https://git-scm.com/book/en/v2/GitHub-Account-Setup-and-Configuration)
4. Liquid Prep project:
- [Git clone Liquid Prep project](https://github.com/Liquid-Prep/Liquid-Prep)
- [Git-clone Liquid Prep project](https://github.com/Liquid-Prep/Liquid-Prep)
5. IBM Cloud account:
- [Create an IBM Cloud account](https://cloud.ibm.com/registration)
6. Liquid Prep Backend Service Endpoint:
Expand All @@ -53,17 +53,17 @@ Instructions on how to 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` too.
**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 (recommended Chrome) to spin up the App in the browser.
The Liquid Prep App can be built and deployed in production for accessing the endpoint URL in any browser (we recommend Chrome).

Please follow the step wise instructions in the [IBM Cloud Deployment Documentation](IBM-CLOUD-SETUP.md).
Follow the stepwise instructions in the [IBM Cloud Deployment Documentation](IBM-CLOUD-SETUP.md).

## Contributing

Please read [CONTRIBUTING.md](https://github.com/Liquid-Prep/Liquid-Prep/blob/main/CONTRIBUTING.md) 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.
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 Please read [CONTRIBUTING.md](https://github.com/Liquid-Prep/Liquid-Prep/blob/main/CONTRIBUTING.md).

## License

Expand Down