Giter Site home page Giter Site logo

nikolasmelui / openbrewerydb Goto Github PK

View Code? Open in Web Editor NEW

This project forked from openbrewerydb/openbrewerydb

0.0 2.0 0.0 13.63 MB

๐Ÿป An open-source dataset of breweries, cideries, brewpubs, and bottleshops.

Home Page: https://www.openbrewerydb.org

License: MIT License

Jupyter Notebook 72.52% TypeScript 27.48%

openbrewerydb's Introduction

๐Ÿป 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!

openbrewerydb's People

Contributors

chrisjm avatar mikeputnam avatar andrewbarber avatar jallend1 avatar tylerkkp avatar juicob avatar dependabot[bot] avatar johnnyk737 avatar amadisonm1209 avatar kenster89 avatar dvavs avatar wkarney avatar alexchong avatar cleif avatar danieleremchuk avatar vitaly-t avatar kylescudder avatar mstewgt avatar eacaraway avatar srusher avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.