marwagaser / WaterApp

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

rewaTer

rewaTer (rewards + water) is a point reward based application in residential areas; such that, a quota is calculated using statistical research about different areas’ water requirement and then comparing it to the average water consumption to get the quota. Therefore, when a certain house’s water meter reading is below the quota with respect to the number of people in the house, the user is granted points which will reward him with offers later on. The points can then be used to redeem vouchers or promo codes provided by the sponsors.

Getting Started

The following guidelines are going to help you set up the application on your local host.

Prerequisites

What things you need to install the software and how to install them

npm

sudo apt install npm

Verify Installation by using the following command:

npm --version

update your packages

sudo apt update

Install NodeJS

sudo apt install nodejs

Verify NodeJS installation

nodejs --version

Angular CLI can be installed using the following command:

npm install -g @angular/cli

Ionic can be installed using the following command:

npm install -g ionic

Installing

A step by step series of examples that tell you how to get a development env running

Use npm to install all the required packages. So inside the BackEnd and Front folders type the following command

npm i

Now inside the BackEnd folder type the following command to start the service:

npm start

As for the Front folder type the following command to start the ionic frontend

ionic serve

End with an example of getting some data out of the system or using it for a little demo

Deployment

Deploy on IBM cloud. ''' ibmcloud target --cf -o [ORGNAME] -s [SPACE] -r [REGION] '''

''' ibmcloud cd push '''

Built With

  • NodeJS - A JavaScript runtime environment
  • MongoDB - Cloud Database was used
  • Ionic - Cross platform frontend framework

Authors

See the list of contributors who participated in this project.

Acknowledgments

  • The people who answer my questions on Stackoverflow

About


Languages

Language:TypeScript 43.2%Language:JavaScript 32.7%Language:HTML 17.5%Language:CSS 6.6%