Tidy up readme

[JackGilmore]

As we want more people to start using this project, we should make a better readme to allow people to clone the project and use it if they want to develop

[chrisdebian]

With AI help, but may help with future content:

OpenWasteMap

A web application that uses data from OpenStreetMap to display recycling centre locations, their accepted materials, materials specifically banned, and opening hours.

🌐 Live Demo: openwastemap.uk

📋 Table of Contents

• About
• Features
• Tech Stack
• Getting Started
  • Prerequisites
  • Installation
  • Running Locally
• Project Structure
• Contributing
• Related Projects
• License
• Contact

🎯 About

This project started as part of CTC21: Put Your City on the Map and continued in CTC22: The Environment.

The Problem

Finding accurate, up-to-date information about local recycling options can be challenging. Which waste is accepted at a Household Waste Recycling Centre varies considerably between locations, and this information is often scattered across multiple sources or outdated.

Our Solution

OpenWasteMap aims to provide Councils and citizens with a shared Open Data source of information about Council-run recycling options in their area. We believe that there is a need for a custom UI for editing and displaying this data, focused on the subject matter. While generic editing facilities of OpenStreetMap and Wikidata can be used by data experts, they're too complex for the general public and Council staff.

✨ Features

• 🗺️ Interactive Map - Browse recycling centres on an easy-to-use map interface
• 📍 Location Information - View detailed information about each recycling centre
• ♻️ Material Lists - See what materials are accepted at each location
• 🚫 Banned Materials - Know what materials are specifically not accepted
• 🕒 Opening Hours - Check operating hours for each facility
• 🔍 Search Functionality - Find recycling centres near you
• 📱 Responsive Design - Works on desktop, tablet, and mobile devices

🛠️ Tech Stack

• Frontend Framework: HTML, CSS, JavaScript (Vanilla or Vue.js - check OpenWasteMapUK directory)
• Data Source: OpenStreetMap
• Mapping Library: Leaflet.js or similar
• Hosting: GitHub Pages / Custom hosting

🚀 Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (version 14.x or higher recommended)
• npm (comes with Node.js) or yarn
• Git
• A modern web browser (Chrome, Firefox, Safari, or Edge)

Installation

1. Clone the repository

git clone https://github.com/JackGilmore/OpenWasteMap.git
cd OpenWasteMap

2. Navigate to the project directory

cd OpenWasteMapUK

3. Install dependencies

If the project uses npm packages:

npm install

Or if using yarn:

yarn install

Running Locally

Option 1: Using a local development server

If the project uses a build tool:

npm run dev
# or
npm start

Option 2: Using a simple HTTP server

For static HTML projects:

# Using Python 3
python -m http.server 8000

# Using Python 2
python -m SimpleHTTPServer 8000

# Using Node.js http-server (install first: npm install -g http-server)
http-server -p 8000

Then open your browser and navigate to:

http://localhost:8000

Option 3: Using VS Code Live Server

1. Install the "Live Server" extension in VS Code
2. Right-click on index.html and select "Open with Live Server"

📁 Project Structure

OpenWasteMap/
├── OpenWasteMapUK/         # Main application directory
│   ├── index.html          # Main entry point
│   ├── css/                # Stylesheets
│   ├── js/                 # JavaScript files
│   └── assets/             # Images, icons, etc.
├── _old/                   # Legacy/archived code
├── .github/                # GitHub workflows and configurations
├── .gitignore              # Git ignore file
├── README.md               # This file
└── LICENSE                 # License information

🤝 Contributing

We welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your help is appreciated.

How to Contribute

1. Fork the repository - Click the "Fork" button at the top right of this page

2. Clone your fork

git clone https://github.com/YOUR-USERNAME/OpenWasteMap.git
cd OpenWasteMap

3. Create a new branch

git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

4. Make your changes - Write your code and test it thoroughly

5. Commit your changes

git add .
git commit -m "Add a descriptive commit message"

6. Push to your fork

git push origin feature/your-feature-name

7. Create a Pull Request - Go to the original repository and click "New Pull Request"

Development Guidelines

• Write clear, commented code
• Follow existing code style and conventions
• Test your changes before submitting
• Update documentation as needed
• Keep commits focused and atomic

Reporting Issues

Found a bug or have a feature request? Please open an issue with:

• A clear, descriptive title
• Detailed description of the issue/feature
• Steps to reproduce (for bugs)
• Expected vs actual behavior
• Screenshots (if applicable)
• Your environment (browser, OS, etc.)

🔗 Related Projects

• OpenStreetMap Wiki - Household Waste in the UK
• Open3R - The Open Data standard for Household Waste Recycling Centres (HWRCs)
• OpenStreetMap - The collaborative map of the world
• Code The City - The civic hackathon community

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

📞 Contact

• Project Maintainer: JackGilmore
• Website: openwastemap.uk
• Issues: GitHub Issues

🙏 Acknowledgments

• Thanks to all contributors who have helped shape this project
• Code The City for providing the hackathon platform
• OpenStreetMap community for the data
• Open Data Manchester for the Open3R standard

---

Made with ♻️ by the OpenWasteMap community

Help us make waste management more accessible and transparent for everyone!