🍹 Salt Rim - Bar Assistant Web Client

Salt Rim is a web client used for connecting to your Bar Assistant server. It's made with Vue 3 and it builds to a static webpage that can be easily hosted anywhere.

Click here to view frontend demo.
Click here to view API demo.
Email: admin@example.com · Password: password

Features

• Always up-to-date: Syncs with the latest Bar Assistant features.
• Multi-platform: Works seamlessly on both desktop and mobile devices.
• Instant search: Find recipes fast with powerful filtering.
• Smart tools: Manage shopping lists, calculate recipe costs, and scale batches with ease.
• Customizable: Supports multiple measurement units, dark theme, and on-the-fly language changes.
• Sharing & organization: Create personal recipe collections, and easily copy and share recipes.
• Importing: Review and import scraped recipe data before adding it to your collection.
• QR codes: Generate QR codes for your cocktail menus instantly.
• PWA-ready: Install it as a Progressive Web App for an app-like experience.

Documentation

Official documentation is available here.

Docker installation

Once you have your BA api instance running, you just need to set API_URL env variable:

$ docker run -d \
    --name salt-rim \
    -e API_URL=http://your-bar-assistant-url \
    -e MEILISEARCH_URL=http://your-meilisearch-url \
    -p 8080:8080 \
    barassistant/salt-rim

For a complete docker compose setup click here.

Manual installation

This steps will build Salt Rim into a static webpage.

1. Clone the repository
2. Install the dependencies

$ npm install

3. Add configuration

Create a new config file in public/config.js, with the following content

window.srConfig = {};
window.srConfig.API_URL = "$API_URL"; // Your API URL: https://api.example.com/
window.srConfig.MEILISEARCH_URL = "$MEILISEARCH_URL"; // Your search engine URL: https://search.example.com/
window.srConfig.DEFAULT_LOCALE = "en-US";
window.srConfig.MAILS_ENABLED = false;
window.srConfig.ALLOW_REGISTRATION = true;

4. Run the build commands

$ npm run build

This will create a dist/ folder with ready to use static files.

5. Or run a dev server with the following command

$ npm run dev

Contributing

Fork the respository, follow manual installation steps and make your changes. Issues and PR's are appreciated.

This project is tested with BrowserStack.

Internationalization

You can use Crowdin Bar Assistant project, and this will automaticall pull new languages.

License

Salt Rim is open-sourced software licensed under the MIT license.