Skip to content

NikolasMelui/openbrewerydb

Β 
Β 

Repository files navigation

🍻 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

πŸš€ Getting Started

Contributing

  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
  • Dates are formatted YYYY-MM-DD (NOTE: Be aware that Excel likes to automatically format dates incorrectly)

πŸš› Roadmap

Task Status
βœ… πŸ“€ Release dataset in JSON and CSV
βœ… βš™οΈ Task > Export JSON (/breweries.csv ➑️ /breweries.json)
βœ… βš™οΈ Task > Split CSV (/breweries.csv ➑️ /data)
βœ… βš™οΈ Task > Combine CSV (/data ➑️ /breweries.csv)
βœ… βš™οΈ Github Action > Validate Data
βš™οΈ Github Action > Update Open Brewery DB API #12
πŸ€– Unit Tests > Tasks

🀝 Contributing

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

πŸ‘Ύ 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

πŸ”£

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

About

🍻 An open-source dataset of breweries, cideries, brewpubs, and bottleshops.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 72.5%
  • TypeScript 27.5%