https://github.com/revuz/chai-spotter
https://github.com/revuz/chai-spotter
leafletjs supabase tea vite
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/revuz/chai-spotter
- Owner: ReVuz
- Created: 2025-05-17T11:38:24.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-05-20T16:01:31.000Z (5 months ago)
- Last Synced: 2025-07-04T00:37:20.361Z (3 months ago)
- Topics: leafletjs, supabase, tea, vite
- Language: TypeScript
- Homepage: https://chai-spotter.vercel.app
- Size: 70.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chai Spotter
Discover finest tea stalls and chai spots with **Chai Spotter**!
A web app to explore, locate, and celebrate the unique chai culture across Kerala, India.
---
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Tech Stack](#tech-stack)
- [Contributing](#contributing)
- [License](#license)
---
## Overview
**Chai Spotter** helps tea lovers and travelers discover authentic tea stalls ("chaya kada") across the world.
Find the perfect spot for your next cup of chai using an interactive map and curated list of the best stalls.
> _"Find your next tea spot ☕"_
---
## Features
- 🗺️ **Interactive Map**: Browse Kerala's tea stalls by location.
- 🎲 **Surprise Me!**: Explore a random tea spot with a single click.
- 🏆 **Featured Chai Spots**: See a curated list of must-visit stalls.
- 🌗 **Dark Mode**: Seamless light/dark theme toggle.
- ⭐ **Ratings & Specialties**: Discover each stall's unique offerings and user ratings.
- 📱 **Responsive Design**: Works beautifully on desktop and mobile.
---
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/) (v18+ recommended)
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
### Installation
```bash
git clone https://github.com/ReVuz/Chai-Spotter.git
cd Chai-Spotter
npm install
# or
yarn install
```
### Running Locally
```bash
npm run dev
# or
yarn dev
```
The app will be available at `http://localhost:5173` (or the port specified in your terminal).
---
## Usage
- **Explore** the map to find tea stalls near you or across Kerala.
- **Click** on a marker or a stall card to view details, specialties, and get Google Maps directions.
- **Try "Surprise Me!"** for a random tea adventure.
- **Switch** between light and dark mode using the toggle button.
---
## Tech Stack
- **Frontend**: React + TypeScript
- **Styling**: Tailwind CSS
- **State Management**: React Hooks
- **Map**: [React-Leaflet](https://react-leaflet.js.org/)
- **Icons**: Lucide React, Icons8
---
## Data Model
Each tea stall is defined as:
```typescript
interface TeaStall {
id: number;
name: string;
location: string;
description: string;
specialties: string[];
position: [number, number]; // [latitude, longitude]
rating: number; // 1-5
imageUrl: string;
}
```
---
## Contributing
Pull requests are welcome!
If you have suggestions for new tea spots, features, or bug fixes, please open an issue or PR.
**To contribute:**
1. Fork this repo
2. Create your feature branch (`git checkout -b feature/your-feature`)
3. Commit your changes (`git commit -am 'Add new feature'`)
4. Push to the branch (`git push origin feature/your-feature`)
5. Open a Pull Request
---
## License
© 2025 Chai Spotter.
---
> _Discover the best tea experiences in Kerala with Chai Spotter!_