Skip to content

Kontractour/CleanCity

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

7 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŒฟ 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.โ€

About

A web app to track recycling and promote sustainability.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published