<p align="center">
<a href="https://barassistant.app" target="_blank"><img src="resources/art/readme-logo.png" alt="Bar assistant Logo" width="500"></a>
</p>
<p align="center">
<img src="https://img.shields.io/docker/v/barassistant/server?style=for-the-badge&sort=semver" alt="Docker image">
<img src="https://img.shields.io/github/license/karlomikus/bar-assistant?style=for-the-badge" alt="Docker image">
<img src="https://img.shields.io/github/actions/workflow/status/karlomikus/bar-assistant/php.yml?branch=master&style=for-the-badge&label=Tests" alt="Tests">
<a href="https://hub.docker.com/r/barassistant/server"><img src="https://img.shields.io/docker/pulls/barassistant/server?style=for-the-badge" alt="Pulls"></a>
</p>
## 🍸 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).
<p align="center">
<a href="https://demo.barassistant.app/bar/docs" target="_blank">Click here to view API demo.</a>
<br>
<a href="https://demo.barassistant.app" target="_blank">Click here to view frontend demo.</a>
<br>
<strong>Email:</strong> admin@example.com · <strong>Password:</strong> password
</p>
## Features
- [Includes over 500 cocktail recipes with detailed information](https://github.com/bar-assistant/data)
- Includes over 250 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
- Support for cocktail variations
- 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
- Single sign-on (SSO) support
- Recipe recommendations based on your favorites and tags
## Documentation
[Documentation is available here.](https://docs.barassistant.app/)
## Container images
Bar Assistant is available as a Docker image on [Docker Hub](https://hub.docker.com/r/barassistant/server) and [GitHub Container Registry](https://github.com/karlomikus/bar-assistant/pkgs/container/barassistant). There is no `latest` tag, so you need to specify version in the tag. For example:
- `barassistant/server:v4.4.1` - This will pull the exact version
- `barassistant/server:v4.4` - This will pull the latest minor release
- `barassistant/server:v4` - This will pull the latest major release
- `barassistant/server:dev` - This will pull the latest development version (not recommended for production)
We recommend that you always use the latest major release, as it will always be the most stable version.
## Environment Variables
Here's a list of interesting environment variables you can set to configure Bar Assistant:
|Name|Default|Description|
|----|-------|-----------|
|REDIS_HOST|redis|The Redis host.|
|CACHE_DRIVER|redis|The cache driver to use (`file` or `redis`).|
|SESSION_DRIVER|redis|The session driver to use (`file` or `redis`).|
|ALLOW_REGISTRATION|true|Allow or disallow user registration.|
|MAIL_REQUIRE_CONFIRMATION|false|Require email confirmation for new user registrations.|
|MEILISEARCH_HOST||The Meilisearch host URL.|
|MEILISEARCH_KEY||The Meilisearch API key.|
|METRICS_ENABLED|false|Enable or disable Prometheus metrics endpoint.|
|METRICS_ALLOWED_IPS||Comma-separated list of IPs allowed to access metrics endpoint.|
|ENABLE_PASSWORD_LOGIN|true|Enable or disable password login.|
|SCRAPING_HTTP_PROXY||HTTP proxy URL for web scraping.|
|SCRAPING_CLIENT_CERT||Path to client certificate for web scraping.|
|MAIL_MAILER||The mailer to use.|
|MAIL_HOST||The mail host.|
|MAIL_PORT||The mail port.|
|MAIL_ENCRYPTION||The mail encryption method.|
|MAIL_USERNAME||The mail username.|
|MAIL_PASSWORD||The mail password.|
|GEN_AI_PROVIDER||Identifier of LLM provider. Supports any provider that PrismPHP supports.|
|GEN_AI_MODEL||Specific model to use from the provider.|
|GEN_AI_TIMEOUT|60|Timeout for LLM provider requests in seconds.|
## 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 our official managed instance. Visit [barassistant.app](https://barassistant.app/) for more information about our cloud offering.
## 3rd Party Integrations
There's an [unofficial Raycast extension](https://www.raycast.com/stupifier/barassistant) maintained by a [community member](https://github.com/zhdenny).
## 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).