Skip to content

openbrewerydb/openbrewerydb

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

It was overwritten because I wasn't paying attention to which file was updated.
0af7852

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 

🍻 Open Brewery DB Dataset

All Contributors

Open Brewery DB Logo

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

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.

Run without code

Postman

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

Run in Postman

πŸš€ Getting Started

  1. git clone git@github.com: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

  • CSVs are organized by data/[country]/[state] or data/[country]/[county_province]
  • Required fields/columns: name, street, brewery_type, city, state (or county_province), postal_code, and country

βš™οΈ 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

πŸ“« 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

πŸ”£

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