danieleremchuk/openbrewerydb

🍻 A free and open-source data set of breweries, cideries, brewpubs, and bottleshops.

Open Brewery DB Dataset

This is the entire dataset for Open Brewery DB.

The intended purpose is to provide an approval-based pipeline to update the dataset and API.

The pipeline is a work in progress, but please feel free to start contributing!

Thank you!

Datasets

CSV JSON

Roadmap

• 📤 Release data set
• ✅ Task > Import JSON (i.e., /breweries.json ➡️ /data)
• ✅ Task > Export JSON (i.e., /data ➡️ /breweries.json)
• ✅ Task > Export CSV (i.e., /data ➡️ /breweries.csv)
• ✅ Task > Import CSV (i.e., /breweries.csv ➡️ /data)
• ⚙️ Github Action > Validate Data
• 🤖 Unit Tests > Tasks
• ⚙️ Github Action > Update Open Brewery DB API

How to contribute

1. Create Pull Request

You can create a pull request via:

• Edit file & create pull request
• Create a pull request from a fork

2. Validation (WIP)

• ESlint (validate JavaScript and JSON)
• Data (validate CSV via goodtables)
• Duplicates (TBD)

NOTE: This is a work in progress. See issues: #2, #3

3. Peer Review

If everything is green, a moderator or I will manually review the data for validity.

TODO: Get moderators. Want to be a moderator? email me!

4. Merge

Hooray! Once the peer reviewer approves, the pull request will be approved and the data will be merged into the master data set.

TODO: Automate the API database update pipeline. In the meantime, this will happen manually. Thank you for your patience. 😊

Feedback

Any feedback, please email me. Cheers! 🍻