Skip to content

gpietrafesavieitez/EcoApp

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Because recycling can also be enjoyable.


View Demo · Report Bug · Request Feature

Table of Contents

About the project

Seen general situation of the society around the 3Rs practice through the time, we have realised that most people don't know how to recycle properly. This app was born in order to solve most of the doubts that even we have had when recycling, reusing o repairing products.

First release of this project is an Android app focused only on the recycling part and allows the user to scan any object with a barcode or QR in it and information of how to recycle it will be shown to the user. If the object doesn't exist user will be able to upload it just by clicking a button. Additional features are multilanguage support (English and Spanish at this moment) and the possibility to see another products uploaded by other users.

Main goal would be a social network that will encourage users to have a good 3Rs rule practice in order to reduce contamination and thus global warming. They will be able to interact with the products by sharing suggestions on how to repair/reuse them. Scanning system would be improved by deep learning recognition to not depend only on barcodes to identify a specific object.

We are aware that not everywhere is recycled the same so the final idea is also to internationalize the application and support more languages.

Built with

  • EcoAppApi - EcoApp API built in Python with Django REST Framework.
  • Android Studio - Main development platform using Kotlin as the programming language.
  • Zxing - Core library for scanning barcode/QR.
  • Retrofit & OkHttp - HTTP client core libraries.
  • Firebase - OAuth 2.0 Authentication API.
  • Glide - Media managment and image loading/caching library.

Getting Started

Requirements

  • Minimum - Android 6.0 Marshmallow (API >= 23)
  • Recommended - Android 8.0 Oreo (API >= 26)

Installation

  • Download last release and install it on your smartphone. You will need a Google Account.

EcoApp v0.1-alpha

⚠️This is a pre-release version for debugging and may be unstable so when using it maybe you will encounter some bugs, in that case please let us know. Thank you.

Usage

  • Logging into the application

  • Once inside you can view products uploaded by other users, view details of each product to know how to recycle them, look for components, scan a product or upload one if it doesn't exist.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated :octocat:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Acknowledgements

Authors

License

🔖 Distributed under the Apache License 2.0. See LICENSE for more information.