Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 3.49 KB

README.md

File metadata and controls

78 lines (53 loc) · 3.49 KB
Raw

Saaf water Dashboard

License Community Website

Dashboard

Getting Started with Saaf water Dashboard (React App)

Saaf water Dashboard (React App) is the front-end for the entire Saaf water platform. Built with:

Instructions to run the Saaf water Dashboard (React App);

  1. Local Development
  2. IBM Cloud

Run the Saaf water Dashboard for local development

Pre-requisites

  1. Install Node and NPM

Install npm packages

  • Start a terminal/CMD in ~/Dashboard/ directory.
  • Execute command npm install.

Run the App

  • Execute command npm start.
  • Open a web browser and enter http://localhost:3000.

Run the Saaf water Dashboard on IBM Cloud for Free

Pre-requisites

  1. IBM Cloud Account:
  2. Install Node and NPM

Build the App for production

  • Start a terminal/CMD in ~/Dashboard/ directory.
  • Execute command npm install and npm run build.

A production ready app's build folder with all dependencies will be created in the ~/Dashboard/build directory.

Deploy the App on IBM Cloud

The App can deployed on IBM Cloud for free with following two free services;

  1. IBM Cloud Foundry

How to Contribute

Thank you for your interest in contributing to saaf-water! Before you begin writing code, it is important that you share your intention to contribute with the team, based on the type of contribution:

  1. You want to propose a new feature and implement it.
    • Post about your intended feature in an issue, and we shall discuss the design and implementation. Once we agree that the plan looks good, go ahead and implement it.
  2. You want to implement a feature or bug-fix for an outstanding issue.
    • Search for your issue in the saaf-water Dashboard issue list.
    • Pick an issue and comment that you'd like to work on the feature or bug-fix.
    • If you need more context on a particular issue, please ask and we shall provide.

Once you implement and test your feature or bug-fix, please submit a Pull Request to https://github.com/saaf-water/Dashboard.

The project reviewers at this time are :

License

Saaf water Dashboard is licensed under the Apache Software License, Version 2. Contributions are subject to the Apache Software License, Version 2.