Skip to content

Johngeorgesample/pgh-coffee

Repository files navigation

Overview

https://pgh.coffee/

image

This repository contains a comprehensive data source of all the coffee shops in Pittsburgh, along with a Next.js application to display and explore this information. Whether you're a local resident looking for a new coffee spot or a visitor seeking the best cafes in the city, this project has you covered.

Features

1. Coffee Shop Data Source

The data source is a curated collection of information about coffee shops in Pittsburgh, including:

  • Name of the coffee shop
  • Address
  • Website

You can find the dataset of all 140+ shops at https://pgh.coffee/api/shops/geojson.

2. Next.js Web Application

The Next.js app provides a user-friendly interface to explore the coffee shop data.

Getting Started

Follow these steps to get started with the project:

  1. Clone the Repository:
git clone https://github.com/johngeorgeample/pgh-coffee.git
cd pgh-coffee
  1. Install Dependencies:
npm install
  1. Get Mapbox Access Token
  • Visit Mapbox and create an access token with all Public scopes checked.
  • Duplicate .env.example as .env and enter your Mapbox Access Token.
  1. Run the Next.js App:
npm run dev

The app will be accessible at http://localhost:3000.

Contribution Guidelines

Contributions are welcome! If you discover a new coffee shop or have updates to existing information, please follow these guidelines:

  1. Fork the repository.
  2. Make your changes.
  3. Create a pull request with a clear description of your changes.

License

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

Acknowledgments

  • Special thanks to the Pittsburgh coffee community for their support and contributions to the data source.