Skip to content

A React Native mobile app for streamlined community environment conservation.

License

Notifications You must be signed in to change notification settings

philiptitus/ReUp

Repository files navigation

REUP - Waste Management & Community Engagement App

CircleCI

Revolutionizing Waste Management with AI and Social Engagement

REUP is a cutting-edge mobile application designed to transform how waste is managed, making it easier for individuals and communities to locate trash collection points, dispose of waste properly, and engage in environmental conversations. The app integrates Google Maps API for navigation and Google Gemini AI for intelligent waste disposal instructions.


Key Features:

  • Locate Trash Collection Points: Use Google Maps to find nearby trash collection points and view the types of waste accepted at each location.
  • Smart Disposal Instructions: Snap a picture of your waste, and the AI will guide you with specific instructions on how to dispose of it properly.
  • Points and Rewards: Earn points for each waste disposal and cash out rewards for eco-friendly actions.
  • Admin Features: As an admin, you can easily add new collection sites, update accepted waste types, and track site usage.
  • Community Engagement: Connect with others through a social platform similar to Instagram. Share ideas, discuss environmental issues, and engage in community-driven initiatives.
  • Leaderboards: Climb the leaderboards by earning points for waste disposal and community engagement.

Getting Started

Prerequisites:

  • React Native: This project is built using React Native. Make sure you have it installed.
  • Google Maps API: You will need API keys to enable the navigation and collection point features.
  • Gemini AI Integration: Ensure you have access to Google Gemini AI for the intelligent waste disposal feature.

How to Run the Project:

  1. Clone the repository:

    git clone https://github.com/philiptitus/ReUp.git
    
  2. Install dependencies:

    cd ReUp
    npm install
    
  3. Configure your environment:

    • Add your Google Maps API Key to the .env file.
    • Set up Google Gemini AI credentials.
  4. Start the development server:

    npx react-native run-android   // For Android
    npx react-native run-ios       // For iOS
    

Backend Access

This App is powered by the SQUARE API, a django server.

The backend source code can be accessed here: Backend Source Code.
API documentation can be found here: API Docs on Postman.


Contribution Guidelines

We welcome contributions from developers passionate about improving waste management and community engagement!

  1. Fork the repository:
    Go to REUP GitHub Repo, and fork the repository.

  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:
    Submit your pull request for review, and include a detailed explanation of the changes.


Support and Contact

For any issues or questions, feel free to reach out through Contact Page.


Credit

This project was initially developed using the Ignite React Native template by Infinite Red. Special thanks to the open-source community for the tools and inspiration!


License

This project is licensed under the MIT License.
© 2024 Philip Titus