Are you ready to save the planet, one recycled item at a time? Look no further! Recycle-M is here to transform you from a casual Earth inhabitant into a full-fledged eco-warrior! 🌱💪
Recycle-M isn't just an app; it's your ticket to the exclusive "I'm Saving the Planet" club! Here's what you get:
- 🔐 VIP Access: Sign up and log in to join the eco-elite!
- 📰 Green Gossip: A feed packed with earth-shattering articles and searchable eco-wisdom!
- 🛒 Eco-Bazaar: Shop 'til you drop (but sustainably, of course)!
- 🔍 Seek & You Shall Find: Our search function is like Google, but greener!
- 💸 Penny-Pinching for the Planet: Track your green expenses and watch your eco-savings grow!
- 📅 Save the Date: Calendar features to plan your world-saving activities!
- 📊 Insight Overload: Dive deep into your balance and expenses (Warning: May cause excessive pride in your eco-efforts)!
- ⚙️ Tailor Your Experience: Customizable user options (because even heroes need preferences)!
- 🦸 Your Eco-Identity: A profile that showcases your green superpowers!
- 🗑️ Waste Not, Want Not: Our state-of-the-art waste collection flow (It's like Uber, but for trash)!
Our digital eco-lair is built with:
- 🐍 Python (Because even snakes care about the environment)
- 🚀 FastAPI (For speed that doesn't cost the Earth)
- 🗃️ SQLAlchemy (Organizing data like a boss)
- 📦 SQLite (Lightweight, just like your carbon footprint should be)
- 🎨 Flutter (For a smooth, cross-platform frontend experience)
- Python 3.11+
- Flutter SDK
- Docker (optional)
-
Clone the repository:
git clone https://github.com/HardMax71/Recycle-M.git cd Recycle-M
-
Set up the backend:
cd backend python -m venv .venv source .venv/bin/activate # On Windows use .venv\Scripts\activate pip install -r requirements.txt
-
Set up the frontend:
cd ../frontend flutter pub get
-
Start the backend:
cd backend uvicorn main:app --reload
-
Start the frontend:
cd frontend flutter run -d chrome # or any other device
If you prefer using Docker:
-
Build the Docker image:
docker build -t recycle-m .
-
Run the Docker container:
docker run -p 8000:8000 -p 5000:5000 recycle-m
Visit http://localhost:5000
in your browser to access the application.
Click to expand
Secure login to access your eco-warrior dashboard
Join the green revolution with our easy sign-up process
Stay updated with the latest eco-friendly news and tips
Shop sustainably in our eco-friendly marketplace
Start your waste collection journey with ease
Locate nearby recycling centers for efficient disposal
Follow the installation guide above and start your journey to becoming an eco-warrior today!
We welcome contributions from all eco-enthusiasts! Check out our CONTRIBUTING.md for guidelines on how to join our mission.
DISCLAIMER: This application utilizes intellectual property, including but not limited to application descriptions and design elements, originally conceived and published by Ana Elisa Renault. The foundational concept and user experience design can be found in the article "The Making of a Recycling App — User Case" available at https://bootcamp.uxdesign.cc/the-making-of-a-recycling-app-user-case-cf7007bde3fe. The visual design elements are sourced from https://www.figma.com/design/VSuuWHIbFbAsDSp2OxNunI/Recycle-M?node-id=30-2365&t=VFKXuHo12ImVsc6q-0.
This implementation is intended for educational and demonstrative purposes only. All rights and credits for the original concept and design belong to their respective owners. Any use, reproduction, or adaptation of this work should be done with full acknowledgment and in compliance with applicable intellectual property laws.
This project is licensed under the MIT License - see the LICENSE.md file for details.
For inquiries, suggestions, or to join our league of extraordinary developers, please refer to the repository owner's profile for contact information. Together, we can code a greener future! 🌿💻🌍
Remember, in the green world of Recycle-M, every day is Earth Day! 🌎🎉