Bins API

Get Leeds waste collection data via API

Features

• Search premises by postcode
• Get premises' scheduled waste collection dates
• Recent premises
• Suprise Me with a random premises
• API for searching premises and getting collection dates
• iCal integration

API Reference

Available at https://bins.felixyeung.com/docs/api

Tech Stack

• Next.js - web framework
• TypeScript - language
• Tailwind CSS - styling
• Node.js - backend runtime
• PostgreSQL - database
• Drizzle ORM - database orm
• Upstash Redis - rate limiting
• Cloudflare Tunnels - secure reverse proxy

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

TUNNEL_TOKEN - your Cloudflare Tunnel's token

Running

Prerequisites

• Docker
• Docker Compose

Setup

Create your .env file as per the Environment Variables section

Run docker compose up to start the project