https://github.com/karlomikus/bar-assistant

Bar assistant is a all-in-one solution for managing your home bar
https://github.com/karlomikus/bar-assistant

api bar cocktails home php recipes rest

Last synced: 5 days ago
JSON representation

Bar assistant is a all-in-one solution for managing your home bar

• Host: GitHub
• URL: https://github.com/karlomikus/bar-assistant
• Owner: karlomikus
• License: mit
• Created: 2022-10-03T16:30:46.000Z (over 2 years ago)
• Default Branch: develop
• Last Pushed: 2024-05-22T15:51:33.000Z (8 months ago)
• Last Synced: 2024-05-22T16:27:11.136Z (8 months ago)
• Topics: api, bar, cocktails, home, php, recipes, rest
• Language: PHP
• Homepage: https://barassistant.app
• Size: 114 MB
• Stars: 401
• Watchers: 7
• Forks: 20
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


    





    

    

    

    



## 🍸 Bar Assistant

Bar Assistant is all-in-one solution for managing your home bar. Compared to other recipe management software that usually tries to be more for general use, Bar Assistant is made specifically for managing cocktail recipes. This means that there are a lot of cocktail-oriented features, like ingredient substitutes, first-class ingredients, ABV calculations, unit switching and more.

This repository only contains the API server, if you are looking for easy to use web client, take a look at [Salt Rim](https://github.com/karlomikus/vue-salt-rim).



    Click here to view API demo.

    


    Click here to view frontend demo.

    


    Email: [email protected] · Password: password



## Features

- [Includes over 300 cocktail recipes with detailed information](https://github.com/bar-assistant/data)

- Includes over 150 base ingredients with categories

- Add and manage multiple bars and bar members

- Fine-grained user control with user roles

- Endpoints for managing and filtering ingredients and cocktails

- Filter recipes by ABV, base ingredient, tags and more

- Filter recipes based on whether you have the right ingredients or not

- Detailed cocktail and ingredient information

- Support for assigning multiple images to resources and image sorting

- Shopping list generation based on missing ingredients in your inventory

- Automatic indexing of data with Meilisearch

- Support for custom cocktail ingredient substitutes

- Support for glass types, utensils, tags, ingredient categories and more

- Cocktail recipe importing via URL, JSON, YAML or custom collections

- Support for cocktail ratings

- Create user-specific cocktail collections for easy referencing and sharing

- Support for cocktail and ingredient notes

- Supports sharing recipes by public links, custom recipe images and printing

- Create public bar menus

- Manage custom API personal access tokens with custom permissions set by users

- Detailed statistics about recipes and user tastes

- Data export support in various formats

- Support for multiple ingredient prices

- Automatic cocktail price calculation based on ingredients

## Managed instance

Bar Assistant will always be open-source and MIT-licensed, but if you want to support the project or don't want to self-host, you can try officialy managed instance. Visit [barassistant.app](https://barassistant.app/) for more information about our cloud offering.

![Cloud offering screenshot](/resources/art/art1.png)

## Documentation

[Documentation is available here.](https://bar-assistant.github.io/docs/)

## Contributing

Contributions Welcome!

For more details, see [CONTRIBUTING.md](/CONTRIBUTING.md).

## Support and Donations

Bar Asistant is free, but maintaining any open source project takes time and resources. If you find Bar Assistant valuable and want to support its future development, consider donating.

[Donate with PayPal](https://www.paypal.com/ncp/payment/9L8T4YJZBRXAS)

## License

The Bar Assistant API is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).