๐ฟ CleanCity+ Building Cleaner, Greener Cities โ One Item at a Time. ๐งญ Overview
CleanCity+ is a modern, web-based application designed to promote sustainability and inspire eco-friendly habits. It empowers individuals and communities to track recycling efforts, learn about waste categories, earn achievement badges, and make pledges toward a cleaner, greener future.
With a smooth, responsive interface built on Bootstrap 5, CleanCity+ combines educational content and interactivity to turn environmental awareness into meaningful action.
โจ Features ๐ Home Page
A welcoming landing page featuring:
A bold hero section with a call to action.
Inspiring recycling facts and visuals.
An introduction to CleanCity+โs mission and goals.
๐๏ธ Waste Categories
Learn about:
Plastic, Paper, Organic, E-waste, and Glass waste.
Proper disposal methods for each category.
Environmental impacts and recycling tips.
โป๏ธ Recycling Tracker
An interactive tool that allows users to:
Log recycling activities by category and quantity.
Sort, search, and delete entries easily.
View progress using Chart.js visualizations.
Earn milestone badges such as Recycling Starter or Eco Champion.
๐ Pledge Section
Users can:
Commit to sustainable habits (e.g., โRecycle 5 bottles weeklyโ).
Track progress based on logged recycling items.
Receive motivational feedback to stay consistent.
๐ฑ Responsive Design
Fully optimized for both desktop and mobile using Bootstrap 5.3.3, ensuring a smooth experience across devices.
๐งฐ Technologies Used Technology Purpose HTML5 Semantic structure and layout. CSS3 Custom styling and responsive design. Bootstrap 5.3.3 Framework for responsiveness and components. JavaScript (ES6) Interactivity, DOM manipulation, and animations. Chart.js Bar charts for visualizing recycling totals. Font Awesome Icons for social media and contact links. ๐๏ธ Project Structure CleanCity+/ โ โโโ assets/ โ โโโ cleancity-workers.jfif # About section image โ โโโ hero-image.jpg # Hero section background image โ โโโ codes/ โ โโโ index.html # Home page โ โโโ categories.html # Waste categories page โ โโโ tracker.html # Recycling tracker page โ โโโ pledge.html # Pledge commitment page โ โโโ styles.css # Custom styles โ โโโ scripts.js # JavaScript for interactivity โโโ README.md # This file โโโ LICENSE # MIT License (optional)
โ๏ธ Installation & Setup
Follow these simple steps to run CleanCity+ locally:
1๏ธโฃ Clone the Repository git clone https://github.com/kontractour/CleanCity+.git cd CleanCity+
2๏ธโฃ Dependencies
No server setup required โ CleanCity+ runs directly in your browser. Ensure your internet connection is active to load:
Bootstrap,
Chart.js, and
Font Awesome (via CDNs).
3๏ธโฃ Launch the Application
Open index.html in your preferred browser:
Double-click the file, or
Use a local dev server (e.g., live-server via npm).
๐ Usage Guide ๐งญ Navigation
Use the top navigation bar to access:
Home
Waste Categories
Recycling Tracker
Pledge
๐ Tracker
Input a waste category and quantity to log recycling items.
Sort, search, or delete entries with ease.
Watch your chart and achievement badges update automatically.
๐ฑ Pledge
Make a recycling commitment and track your progress.
View motivational prompts tied to your recycling data.
๐ฉ Contact
Use the footer links to:
Connect on social media,
Send an email, or
Learn more about the developer.
๐ค Development & Contributing
Contributions are welcome! Follow these steps to contribute to CleanCity+:
1๏ธโฃ Fork the Repository
Create your own copy of the project on GitHub.
2๏ธโฃ Clone Your Fork git clone https://github.com/yourusername/CleanCity+.git
3๏ธโฃ Create a New Branch git checkout -b feature/your-feature-name
4๏ธโฃ Make and Commit Changes git add . git commit -m "Describe your feature or fix"
5๏ธโฃ Push and Submit a Pull Request git push origin feature/your-feature-name
Then open a Pull Request on the original repo and describe your update.
๐ License
This project is licensed under the MIT License. See the LICENSE file for full details.
๐ง Contact
Developer: Godswill Okereke
๐ฉ Email: okerekegodswill7@gmail.com
๐ LinkedIn: linkedin.com/in/godswillokereke
๐ Phone: +234 810 553 3755
๐ Acknowledgments
CleanCity+ is inspired by the global movement toward sustainability, climate action, and environmental awareness. Every small recycling step contributes to a massive collective change. ๐๐
๐ฎ Future Improvements
๐ User authentication for personalized tracking.
๐พ Persistent data storage via localStorage or backend database.
๐ฑ Enhanced mobile responsiveness with touch gestures.
๐ Integration of real-time community statistics and leaderboards.
๐ โCleanCity+ โ Because every bottle, bag, and battery counts.โ