andrew21-mch / cleancity

waste management app

Table of Contents

• Introduction
• Key Features
  • User
  • Admin
• Get the App
• Requirements
• Build and run the app
• Build and run the app
• ToDos
• Contributors
• Contributors

cleancity

The outcome of indiscriminate disposal of solid wastes expose human to environmental degradation such as in flooding, drainage obstruction, widespread of infectious diseases, cholera, diarrhea typhoid fever, waterway blockage which leads to infestation of flies, ticks and breeding of mosquitoes that cause malaria, this can go a long way to putting the health of the community at stake.

CleanCity aims at reducing environmental degradation degradation such as in flooding, drainage obstruction, the spread of environmental infections such as cholera and malaria. offers the community with solution to locating closest trash places to dump, provides local councils with solution which notifies them on trash places within the community that are full and the route to these places so it can be emptied. This will go a long way to reducing

Features

• User

- Locate all nearest trash places around you - Show approximate distance from user to a trash place - Get directions to the trash place. - show shortest route to full trash place

• Admin

App

• You can get the Community App Here
• You can get the Admin app Here

Requirements

• google_fonts: ^2.3.1
• google_maps_flutter: ^2.1.2
• location: ^4.3.0
• flutter_polyline_points: ^1.0.0
• geolocator: ^8.0.1
• geoflutterfire: ^3.0.3
• cupertino_icons: ^1.0.2
• cloud_firestore: ^2.5.1
• flutter_spinkit: ^5.1.0
• flutter_svg: ^0.19.1
• shared_preferences: ^2.0.5

Build

Build and Run the app

• Open the project on Android Studio or intellij.
• 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:

<application
    <meta-data android:name="com.google.android.geo.API_KEY"
            android:value="YOUR API KEY" />

• 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 

Contribute

Contribute To the App

Are you interested in making this app better, there are two parts of the app as listed above

• clone user app here

git clone https://github.com/City-solutions/cleanCity

• clone admin app here

git clone https://github.com/City-solutions/CleanAdmin

• open with your prefered android editor and make your changes inside the src directory
• done?, stage and commit your changes

git add FILECHANGED
git commit -m "description of change made

• now create a branch with the name describing the changes you made

git checkout -b descriptive_branch_name

• push to the branch

git push --set-upstream origin descriptive_branch_name

• Open a pull request with some description of what you have done

• Thanks~~~

TODOS

• Improve the User Interface
• Integrate GPS services
• Integrate more locations
• Add Sensitization messages on home screen.

Contributors

# Name	# Email	# Twitter
Lukong Anne M	[email protected]	@anne_machinda
Nfon Andrew T	[email protected]	@nfonandrew73
Nyong Godwill N	[email protected]	@nyong_godwill
Ngwa Jude A	[email protected]	@judisco_jardon

LICENSE

this app is a free app, you are free to modify and use under the MIT LICENSE