Bar Assistant 开源项目教程

Bar Assistant 开源项目教程

bar-assistant Bar assistant is a self hosted application for managing your home bar. 项目地址: https://gitcode.com/gh_mirrors/ba/bar-assistant

1. 项目介绍

Bar Assistant 是一个专为管理家庭酒吧而设计的全方位解决方案。与通常面向更广泛用途的食谱管理软件不同，Bar Assistant 专注于管理鸡尾酒配方。它提供了许多鸡尾酒相关的功能，如替代原料、主要原料、酒精度（ABV）计算、单位切换等。

该项目仅包含 API 服务器，如果您需要一个易于使用的 Web 客户端，可以查看 Salt Rim。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保您的系统上已安装以下软件：

• Docker
• Docker Compose

2.2 克隆项目

首先，克隆 Bar Assistant 项目到本地：

git clone https://github.com/karlomikus/bar-assistant.git
cd bar-assistant

2.3 启动项目

使用 Docker Compose 启动项目：

docker-compose up -d

2.4 访问应用

项目启动后，您可以通过以下地址访问 Bar Assistant：

• API 地址: http://localhost:8000
• 前端演示地址: http://localhost:3000（如果您使用了 Salt Rim 客户端）

3. 应用案例和最佳实践

3.1 管理家庭酒吧

Bar Assistant 可以帮助您管理多个家庭酒吧，并为每个酒吧添加成员。您可以设置用户角色，控制用户的权限。

3.2 鸡尾酒配方管理

项目内置了超过 300 种鸡尾酒配方，您可以添加、删除或修改这些配方。此外，您还可以根据 ABV、基础原料、标签等过滤配方。

3.3 购物清单生成

Bar Assistant 可以根据您当前的库存自动生成购物清单，列出您缺少的原料。

4. 典型生态项目

4.1 Salt Rim

Salt Rim 是一个与 Bar Assistant 配套的 Web 客户端，提供了用户友好的界面来管理鸡尾酒配方和家庭酒吧。

4.2 Meilisearch

Bar Assistant 使用 Meilisearch 进行数据的自动索引，确保快速和高效的数据检索。

通过本教程，您应该能够快速启动并使用 Bar Assistant 项目，并了解其主要功能和生态系统。

bar-assistant Bar assistant is a self hosted application for managing your home bar. 项目地址: https://gitcode.com/gh_mirrors/ba/bar-assistant