Skip to content

Latest commit

 

History

History
73 lines (57 loc) · 5.98 KB

README.md

File metadata and controls

73 lines (57 loc) · 5.98 KB
Raw

BuzzBot Logo

BuzzBot

Track your consumption of your favorite alcoholic drinks

Excessive alcohol use is a significant factor contributing to 1 in 8 deaths among individuals aged 20-64. Monitoring and managing your alcohol consumption is crucial for maintaining good health, and that's where BuzzBot comes in. With BuzzBot, keeping track of your drinks has never been easier.

By simply logging your drinks, BuzzBot provides a comprehensive overview of your alcohol intake. It calculates the number of standard drinks you've consumed and helps you gauge how close you are to the recommended limit for a healthy lifestyle. But BuzzBot offers even more than just tracking your intake.

BuzzBot goes beyond basic functionality by offering intuitive graphs and insightful reports. You can visualize your alcohol consumption patterns over time, gaining a better understanding of your habits. Additionally, the reports feature allows you to identify and explore the drinks you have rated highest, giving you valuable insights into your preferences.

With BuzzBot, you can take charge of your alcohol consumption and make informed decisions about your health. Start using BuzzBot today to prioritize your well-being and enjoy a balanced lifestyle.

Build Status

Branch macOS Build Status Linux Build Status Windows Build Status Code Review
master Actions Status Build Status Build Status CodeFactor
develop Actions Status Build Status Build Status CodeFactor

Keep track of:

  • Your favorite drinks
  • Your favorite alcohol producers
  • Number of standard drinks consumed for the week
  • Number of standard drinks left for the weeks
  • Average ABV & IBU per drink
  • Drink notes
  • Graphs

BuzzBot on KDE Plasma

BuzzBot on KDE

BuzzBot on macOS

BuzzBot on macOS

BuzzBot on Windows

BuzzBot on Windows

---------

Installation instructions

  • git clone https://github.com/minorsecond/BuzzBot.git
  • cd BuzzBot
  • mkdir build && cd build
  • cmake -DCMAKE_BUILD_TYPE=Release .. If you'd like to build the app custom for your CPU, run cmake -DCMAKE_BUILD_TYPE=RelLocalCpu
  • cmake --build . --target BuzzBot. If you want to run tests, run cmake --build . --target functions_test.
  • If you're running macOS, you'll have a BuzzBot.app file in the build directory.
  • If you're running Linux, you can install the app in ~/.local/bin by running cmake --install .. The app should then be available in your app menu.
  • If using a Samba share in Linux to share your database across multiple devices, be sure to add the nobrl mount option for the share that the DB file will reside on. This prevents your SMB client from sending byte range locks to the server. Without this addition, you will get a locked database error.

Developing BuzzBot

  • Dependencies:
    • Qt 6.2.4
    • G++11
    • Boost 1.79 or greater
    • Sqlite3
    • Catch2 (3.0 or greater)
  • CLion is the preferred IDE, but you can obviously use anything.
  • Please run unit tests after making your changes. A CI system is in place to protect against bad PRs but you will save yourself time by doing so.