openbrewerydb / openbrewerydb-gatsby

Official Open Brewery DB website built with Gatsby (deprecated)

🍻 Open Brewery DB Dataset

This is the open-source dataset for the Open Brewery DB API which is served by a REST API built with Ruby on Rails

🎯 Purpose

Provide an approval-based pipeline to update the dataset and API.

🗄 Data Formats

• CSV - Full Dataset
• JSON
• PostgreSQL SQL

API

Access the dataset programmatically via the Open Brewery DB API. Use the following tools to get started without any code:

databar.ai

If you don't know how to use APIs, you can use Brewery DB without code through the databar.ai platform.

Postman

A shared Postman collection containing all the API requests to fetch breweries information from the open-source dataset.

🚀 Getting Started

1. git clone [email protected]:openbrewerydb/openbrewerydb.git
2. cd openbrewerydb && npm install

🤝 Contributing

For information on contributing to this project, please see the contributing guide and our code of conduct.

1. Fork the repository
2. Add or update breweries in the CSV (Excel, Google Sheets)
3. Submit a Pull Request

Tips

First and foremost, don't worry about messing up! 🙂 Thank you so much for contributing! 🙌

• CSVs are organized by data/[country]/[state_province]
• Required fields/columns: name, brewery_type, city, state_province, postal_code, and country
• When adding a brewery, do not include an id. This will be created after review.
• Please either add to breweries.csv (preferred if adding breweries for a new country) or the individual state/province CSV file. Adding to both at the same time may introduce duplicates/errors.

⚙️ Scripts

These are the npm scripts used to maintain this dataset.

• npm run csv:combine - Combine CSVs from country/state-region folders into breweries.csv
• npm run csv:split - Split breweries.csv into country/state-region/city CSVs
• npm run contributors:add - Add contributor (interactive CLI)
• npm run contributors:check - Check if there are any missing contributors
• npm run contributors:generate - Generate contributors into README.md
• npm run generate:ids - Generate unique OBDB IDs based on the brewery name and city and overwrite breweries.csv
• npm run generate:json - Generate JSON from breweries.csv output to breweries.json
• npm run generate:sql - Generate PostgreSQL SQL from breweries.csv output to breweries.sql
• npm run validate - Validate CSVs based on JSON Schema
• npm run workflow:maintain - Combine, generate, split (used when updating individual CSVs)

👾 Community

• Join the Newsletter
• Join the Discord

📫 Feedback

Any feedback, please email me.

Cheers! 🍻

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Mike Putnam 🔣	Andrew A. Barber 🔣	Jason Allen 🔣	Juicob 🔣	Will Karnasiewicz 🔣	Dylan T. Vavra 🔣	Madison Martinez 🔣
Daniel Eremchuk 🔣	Alex Chong 🔣	Matt S 🔣	Samuel Rusher 🔣	Evan Caraway 🔣	Tyler K Kuromiya Parker 🔣	kendellmendoza 🔣
Johnnyk737 🔣	James Schuler 🔣	Creighton Leif 🔣	Vitaly Tomilov 💻	Kyle Scudder 🔣	Chris Mears 💬 💻 🔣 🚧 📆 🔧 ✅	donkeyslaps 🔣
Pranav Davar 🔧	Alexandre Hernandes Barrozo 🔣	Resten 🔣	Matt Higgins 🔣	Alex Justesen 🔣	Craig Kelly 🔣	Krzysztof Rewak 🔣
John Baumert 🔣	Charlie Cox 🔣	Miles Kane 🔣	Anthony Laflamme 💻	Georg Engelsmann 🔣	Clinton Williams 🔣	Brent Busby 🔣
kenster89 🔣	Adilet Sarsembayev 🔣	Pranav Davar 🔣	b-mc2 🔣	Nicole 🔣	Nicholas Hance 🔣	Joachim Nilsson 🔣
Alejandro Lopez Rocha 🔣	zshapleigh 🔣	Praval Visvanath 🔣	JohnHenry 🔣	Alfredo Garcia 🔣

This project follows the all-contributors specification. Contributions of any kind welcome!

openbrewerydb-gatsby's Issues

Add All Contributors

Feature request

Overview

• Add all-contributors to this repo: https://allcontributors.org/
• Maybe add to the website too and not just the Git repo?

Add newsletter signup form

Feature request

Overview

Completely forgot to add the MailChimp newsletter signup form to the new documentation site 🤦‍♂

Include:

Tasks

• Add signup form for MailChimp newsletter
• Add Thank you page

Searching breweries by latitude-longitude

Feature request

Overview

Add support for searching breweries by latitude & longitude. This is useful when we need to find the breweries closer to the current location of a user, especially in a mobile application.

The API can look like https://api.openbrewerydb.org/breweries?by_location=<latitude>,<longitude> and output can be sorted by the distance.

(Not sure if this is the right place for API feature requests)

Fix FOUC issue

Bug Report

Describe the bug

There is a flash of unstyled content (FOUC) displayed when loading the page causing a jarring user experience.

Steps to reproduce bug

1. Go to https://www.openbrewerydb.org
2. See the flash of unstyled content

Expected behavior

The page displays with a two-column layout on load.

BUG: Fix source code flash on load

Bug Report

Describe the bug

When loading the page in Firefox and Chrome, you see all of the source code for a split-second before the website loads up.

Steps to reproduce bug

1. Go to https://www.openbrewerydb.org/
2. Reload the page

Expected behavior

The site should load up without showing the source code flash.

Screenshots

Device information

Desktop

• OS: Mac OS X
• Browser: Chrome and Firefox (probably others)

Additional context

This started happening after running through #3. There might be something related to the changes made there (and there were a lot of changes) which affected the rendering. The starter theme I used, gatsby-gitbook-starter is a mess and probably should be built from the ground-up.

Add Brewery Search component

Feature request

Overview

The previous Open Brewery DB website had a simple react component which would use the API to search for a brewery. It can be imported but probably needs some revisions since it was utilizing TailwindCSS utility classes before.

Additional context

• https://openbrewerydb.netlify.com/
• https://github.com/chrisjm/openbrewerydb-website

Tasks

• Add Brewery Search component

Screenshots

Implementation notes

This section will be used by the assigned developer for any additional notes.

Question

hello sorry for making this message as a bug but i dont how to contact the owner of this site/api. I am a student that want to use your api for a project. I am in my second degree of MCT at Kortrijk in Belgium and have a couple questions about your database

Redesign

Feature request

Overview

Redesign the website. Preferably in Svelte and MDX.

Comment if you are interested and a designer.

Fix "Edit on Github" button

Bug Report

Describe the bug

Clicking in Firefox doesn't work anymore.

Steps to reproduce bug

1. Go to https://www.openbrewerydb.org
2. Click on "Edit on Github"

Expected behavior

It will link to Github to edit the file and open a PR

Screenshots

If applicable, add screenshots to help explain your problem.

Device information

Desktop

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context

Add any other context about the problem here.

Add eslint and normalize

Feature request

Overview

The codebase doesn't currently have a eslint or any linting configuration which will make it difficult to maintain code quality via contribution.

Tasks

• Set up eslint
• Fix any warnings & errors
• Add Github Actions for linting

Implementation notes

• Taking most of the eslint rules from Wes Bos's No-Sweat™ Eslint and Prettier Setup. I don't want to just extend because I think it will be helpful for others to see the settings and make any suggestions later on.
• There are still some errors and warnings related to emotion and CSS. I think emotion was upgraded to v10 without actually migrating properly. I created a new bug issue to handle this overhaul. See #5

add clarification to the documentation

Feature request

Overview

The documentation page does not indicate that the maximum number of breweries displayed is limited to 15.

Include:

Please add this update.

Tasks

• Task 1
• Task 2
• Task 3

Screenshots & Diagrams

Add any screenshots or diagrams here to help with implementation.

Additional context

Add any other context.

Implementation notes

This section will be used by the assigned developer for any additional notes.

Fix Emotion/CSS issues

Bug Report

Describe the bug

There are still a few warnings in the console related to emotion and react-emotion. It seems react-emotion is not longer necessary with emotion v10. However, I don't think things were updated properly and needs a full overhaul.

• https://www.npmjs.com/package/react-emotion
• https://emotion.sh/docs/migrating-to-emotion-10

Steps to reproduce bug

1. Open the Inspector console
2. See the errors & warnings

Expected behavior

No errors or warnings related to CSS or emotion

Screenshots

Support CORS

Feature request

Support CORS

Overview

So that web applications can make use of the API.