Bar Assistant is a self hosted application for managing your home bar. It allows you to search and filter cocktails, add ingredients and create custom cocktail recipes.
This repository only contains the API server, if you are looking for easy to use web client, take a look at Salt Rim.
Click here to view API demo.
Click here to view frontend demo.
Email: admin@example.com · Password: password
- Includes all current IBA cocktails
- Over 100 ingredients
- Add and manage multiple bars
- Fine grained control with user roles
- Endpoints for managing of ingredients and cocktails
- Mark ingredients you have and get all cocktails that you can make
- Detailed cocktail and ingredient information
- Ability to upload and assign images
- Shopping list for missing ingredients
- Automatic indexing of data with your prefered search engine
- Supports all drivers that Laravel Scout supports: Algoila, Meilisearch, Database
- Cocktail ingredient substitutes
- Assign glass types to cocktails
- Cocktail recipe scraping
- Cocktail ratings
- User cocktail collections
- Cocktail notes
Documentation is available here.
Feel free to create a pull request or open a issue with bugs/feature ideas.
You can use docker to quick start with the development.
- Clone the repository
- Copy
.env.devas.env, or setup your own env file - Run
docker compose up -d - Then run the following commands:
$ docker compose exec app composer install
$ docker compose exec app php artisan key:generate
$ docker compose exec app php artisan storage:link
$ docker compose exec app php artisan migrate- (Optional) Add bar data
$ git clone https://github.com/bar-assistant/data.git resources/dataXdebug vscode launch config:
{
"name": "Listen for Xdebug",
"type": "php",
"request": "launch",
"port": 9003,
"hostname": "host.docker.internal",
"pathMappings": {
"/var/www/cocktails/": "${workspaceFolder}"
}
}The Bar Assistant API is open-sourced software licensed under the MIT license.