REward ♻️
Welcome to the REward technical documentation!
REward incentivizes recycling by rewarding users with points for recycling plastic and metal items at smart kiosks. Points can be redeemed for exclusive offers from partner businesses.
{: .mobile-frame }
Project Structure
The project consists of three main components working together:
- Flutter App: The mobile interface for users to track points, find kiosks, and redeem rewards.
- PHP API: The bridge between the hardware, Firestore database, and Cloud Messaging.
- ESP32 Kiosk: The hardware component that detects recycling items and communicates with the system.
Where to Start?
- If you are new to the project, start with the Beginner's Guide.
- If you want to dive into the code, check the Flutter Codebase Reference, API Reference, or the Detailed API Endpoints.
- For hardware enthusiasts, see the ESP32 Integration.
Built with ❤️ for the environment by the REward Team.