Code Monkey home page Code Monkey logo

flow's Introduction

Flow - Just go with the flow!

Flow is a water source location mobile app that helps students of the University of Bamenda, Cameroon to find/locate clean water sources.

Introduction

Flow came about as a result of the persistent water crises in Bambili, Cameroon. This is the location of the University of Bamenda in the North West Region of Cameroon. Due to the high influx of people(students) into this locality, water shortages have been the order of the day. The water is being rationed to ensure everybody gets water (unfortunately not everyone gets water as there are times some areas go weeks without water).

Let's consider two locations in Bambili A and B. As a result of the overpopulation leading to water shortage, there could be water today at A and maybe tomorrow at B. The next day there might be no water at at A and B forcing students to go to say another location, C in search of water. Chances are there might be no water at C and now the students will be forced to go to D. Bottom line nobody knows where exactly water is flowing neither does evrybody know all the possible locations of getting water in Bambili. There are locations which go weeks or months without water; it's very difficult especially for new people in the community to find water. This is where flow comes in to save the day!

Key Features

  • Locate all clean water sources around you by radius.
  • Show approximate distance from user to a water source.
  • Get directions to the water source.
  • Save your favourite water sources.
  • Indicate if water is flowing at a water source or not.

Get the App!

You can get the .apk file here. Download and install the app.

Usage

  • Open the app.
  • Explore!
  • You can also learn how the app works here

How to Build

Follow this tutorial on how to install and set up flutter for mobile development. Clone the repository: git clone https://github.com/Developer-Student-Clubs-UBa/Flow.git

Requirements

The following Flutter dependencies are required:

  • flutter_svg: ^0.19.1
  • google_maps_flutter: ^2.0.1
  • location: ^4.1.1
  • cloud_firestore: ^1.0.3
  • firebase_core: ^1.0.2
  • shared_preferences: ^2.0.5
  • flutter_polyline_points: ^0.2.6

Include the package name and version number in the pubspec.yaml file below the dependencies section.

Steps to run

  • Open the project on Android Studio.
  • Get your Google Maps API key. For Android, follow instructions here
  • Add the API key to your Flutter app in the application manifest (android/app/src/main/AndroidManifest.xml), as follows:
<manifest ...
  <application ...
    <meta-data android:name="com.google.android.geo.API_KEY"
               android:value="YOUR ANDROID API KEY HERE"/>
  • Run the code on Android studio and view the app on your emulator of choice or mobile device. You can also run the app from the terminal using: flutter run

Build the application following this tutorial.

TODOs

  • Make the get directions feature fully functional.
  • Distance Calculation.
  • Implement a voting system to indicate if a water source has water supply or not.

Contributors

  • Ida Delphine
  • Nuikweh Lewis
  • Alouzeh Brandone
  • Chi Karl

flow's People

Contributors

nuilewis avatar dscuba2020 avatar idadelveloper avatar bernandez avatar chikarl avatar nsedrickm avatar

Stargazers

Maciej Olejnik avatar  avatar  avatar WARRI EMMANUEL WARRI avatar  avatar  avatar  avatar Hawawou avatar  avatar Mohamed Gadaphy Nkwenkwat avatar Petra avatar  avatar  avatar  avatar

Watchers

James Cloos avatar  avatar

flow's Issues

Typo in README.md

I found a typo in the README just after requirements.

I think it should be pubspec.yaml instead of pubspec.ymal

Tap status

Unable to change status of tap from flowing to not flowing..... Screenshot_20210328-233933.png

Compatability

App doesn't seem to install on Android version 6.0(Itel A12)

Buttons

App buttons failed to carry out task.... Buttons include the direction button and add favourites buttonScreenshot_20210328-233933.png

Distance measurements

Distance measurements not provided..... This is due to the fact that individuals location is unknown for calculating the approximate distance to the various tapsScreenshot_20210328-235401.png

Tapping on Get Directions does nothing.

I can't seem to get directions from my location to the water source. I keep tapping on the get directions button nut nothing happens. I tried it with location off and with location on but no noticeable difference.
Screenshot_20210328-232427

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.