/vue-salt-rim

Salt Rim is a Vue based web client used for connecting to Bar Assistant server instance.

Primary LanguageVueMIT LicenseMIT

Logo

Docker image License Build

🍹 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

  • Beautiful UI for your Bar Asistant server
  • Implements all supported features of Bar Assistant
  • Desktop and mobile support
  • Powerful search and filtering using Vue Instantsearch
  • Support for multiple measurement units
  • Manage your personal shopping list
  • Support for markdown in cocktails and ingredients
  • Automatically add missing ingredients to your shopping cart

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 \
    -p 8080:8080 \
    kmikus12/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
  1. Add configuration

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

window.srConfig = {}
window.srConfig.API_URL = "http://YOUR_BA_API_URL"
  1. Run the build commands
$ npm run build

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

  1. 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.

License

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