Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/karlomikus/vue-salt-rim
Salt Rim is a Vue based web client used for connecting to Bar Assistant server instance.
https://github.com/karlomikus/vue-salt-rim
bar cocktails home self-hosted vue
Last synced: 1 day ago
JSON representation
Salt Rim is a Vue based web client used for connecting to Bar Assistant server instance.
- Host: GitHub
- URL: https://github.com/karlomikus/vue-salt-rim
- Owner: karlomikus
- License: mit
- Created: 2022-10-06T18:48:56.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-16T18:28:22.000Z (2 months ago)
- Last Synced: 2024-09-16T21:07:46.207Z (2 months ago)
- Topics: bar, cocktails, home, self-hosted, vue
- Language: Vue
- Homepage: https://barassistant.app
- Size: 9.84 MB
- Stars: 93
- Watchers: 5
- Forks: 17
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🍹 Salt Rim - Bar Assistant Web Client
Salt Rim is a web client used for connecting to your [Bar Assistant](https://github.com/karlomikus/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: [email protected] · Password: password
## Features
- Intuitive UI for your Bar Assistant instance
- Supports all features of Bar Assistant
- Desktop and mobile support
- Powerful search and filtering capabilities using [Vue Instantsearch](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/vue/)
- Support for multiple measurement units
- Personal shopping list management and exporting
- Markdown support for cocktails and ingredients
- Automatic ingredient suggestions
- Dark theme support
- Localizations available: English, German, Croatian, French, Polish
- Progressive Web App (PWA) capabilities
- Organize your personal recipe collections
- Easy recipe copying and sharing
## Documentation
[Official documentation is available here.](https://bar-assistant.github.io/docs/)
## Docker installation
Once you have your BA api instance running, you just need to set `API_URL` env variable:
``` bash
$ 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](https://github.com/bar-assistant/docker/).
## Manual installation
*This steps will build Salt Rim into a static webpage.*
1. Clone the repository
2. Install the dependencies
``` bash
$ npm install
```
3. Add configuration
Create a new config file in `public/config.js`, with the following content
``` js
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
``` bash
$ 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
``` bash
$ npm run dev
```
## Contributing
Fork the respository, follow manual installation steps and make your changes. Issues and PR's are appreciated.
### Internationalization
You can use Crowdin Bar Assistant project, and this will automaticall pull new languages.
If you want to contribute translations of the UI you can find all the strings that need translations in `src/locales/` directory. Copy one of the locale files and start translating the strings. For extra information you can check out the [i18n plugin this project is using here](https://vue-i18n.intlify.dev/).
## License
Salt Rim is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).