Skip to content

Beginner's Guide 🚀

Welcome to the REward ecosystem! This guide is designed for beginners who want to understand how the project works from the ground up.

Onboarding{: .mobile-frame }

What is REward?

REward is a smart recycling system. Imagine a vending machine, but instead of putting money in to get a soda, you put a plastic bottle or an aluminum can in to get points on your phone.

The Problem

Traditional recycling can be boring and lacks immediate feedback. Many people don't know if their recycling efforts actually matter.

The REward Solution

By "gamifying" recycling, we make it fun: 1. Drop an item in the REward kiosk. 2. Earn Points instantly via the app. 3. Compete on a leaderboard. 4. Redeem points for discounts at local shops.

Home Dashboard{: .mobile-frame }

How it Works (The Ecosystem)

The project is split into three parts that "talk" to each other constantly:

1. The Smart Kiosk (The "Body")

  • Powered by an ESP32 microcontroller.
  • Uses sensors to detect if an item is Plastic or Metal.
  • Uses an ESP32-CAM to scan your user QR code.
  • Sends data to the API when a successful recycle happens.

2. The PHP API (The "Brain")

  • Lives on a web server (Hostinger).
  • It handles the "business logic".
  • When the Kiosk says "User X recycled a can", the API updates the Firebase Database and sends a Push Notification to the user's phone.

3. The Flutter App (The "Face")

  • What the user sees on their Android or iPhone.
  • Shows your current points.
  • Shows a map of where the nearest kiosks are.
  • Generates your unique QR code so the kiosk knows who you are.

QR Code Example{: .mobile-frame }

Basic Concepts

  • Kiosk: A physical recycling station. Each has a unique ID.
  • Transaction: Every time you recycle, a "transaction" is recorded.
  • Points: The currency of the app. Metal often gives more points than plastic!
  • Vouchers/Offers: Coupons you get by spending your points.

Next Step: Learn about the Ecosystem Architecture in detail.