jo-gross / Cocktail-Manager

The Cocktail Manager is an efficient tool for easily documenting and accessing cocktail recipes behind the bar. It also includes essentail bar management features like cost calculations and stats tools.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Cocktail-Manager

an efficient tool for easily documenting, managing and accessing cocktail recipes behind your bar.

GitHub Actions Workflow Status

Table of Contents

πŸ“ Overview

The Cocktail-Manager is a web application for managing cocktail recipes and ingredients. It is designed to be used in a bar with several users, with different roles and permissions. Originally a main goal was to create a compact view with all relevant infos from a high detailed cocktail recipes. Step by step the application grew and now it is a full-featured cocktail management tool. It combines the background management like financial/price calculation overview for partys or events, as well as the total production price of a cocktail, with the detailed recipe making and the compact view for the bartenders during the evening.


🧩 Features

  • Multiple seperated Bars - You can manage multiple bars with different recipes and users without sharing data between them.
  • User management - Invite and manage users with different roles
  • Cocktail recipe management - Add, edit and delete cocktail recipes - in very detailed form.
  • Optimal and optimized for bartenders - Option for easy search and compact view with the necessary steps for an cocktail
  • Party/Event appraisal - Calculate the amount of ingredients for a specific event or party, based on the cocktails you want to serve
  • Financial and statistics - See the costs of your cocktails and create statistics of the shaked cocktails easily
  • Ingredient importer - Ingredients from some websites (like conalco.de or rumundco.de) can be imported with a single click
  • Unit sensitive - You can define available units for your ingredients and the application will use them for the calculations

πŸ–ΌοΈ Screenshots

Bartenders view / Pre-configured overview card
Bartenders view / With search card
Cocktail form
Statistics

πŸš€ Getting Started

System Requirements:

  • Docker
  • Google Cloud Project (for authentication)
  • Node.js (only for local development)

Google Client ID and Secret:

To generate the Google OAuth credentials, go to the Google Developer Console and create a OAuth 2.0-Client with the following settings:

Getting started with cloning the repository and copy the .env.example to .env

git clone https://github.com/jo-gross/Cocktail-Manager.git
cd Cocktail-Manager
cp .env.example .env

Enter your Google Client ID and Secret in the .env file and set the other environment variables.

When the application is running, you should be able to access it at http://localhost:3000


🐳 Docker

Using docker-compose

Run with prebuild images from ghcr.io

docker-compose up -d

Using locally build

Build the images

docker-compose up -d --build

βš™οΈ Local development

One-time setup:

Enable corepack to use yarn

sudo corepack enable

Starting development:

Start the database

docker-compose up postgres -d

Install all dependencies

yarn install

Apply migrations (WARNING: this could drop all of your local data, pay attention)

yarn prisma migrate dev

Start the application

yarn dev

All ui changes are automatically reloaded, but you need to restart the server when changing the api

Developing changes that include database schema changes:

Push your changes without creating a migration

yarn prisma db push

When you are done with your changes, create a migration

yarn prisma migrate dev

All other help can be found in the Prisma Documentation


πŸ“’ Changelog

All changes to the project are documented in the Changelog, automatically generated by when creating a new release.


🀝 Contributing & Support

To grow the project, we need your help! See the links below to get started.


πŸ“„ License

This project is licensed under the GNU AGPL v3 license with a Common Clause v1.0 selling exception.


πŸ€— Acknowledgments

Return


About

The Cocktail Manager is an efficient tool for easily documenting and accessing cocktail recipes behind the bar. It also includes essentail bar management features like cost calculations and stats tools.

License:Other


Languages

Language:TypeScript 97.6%Language:PLpgSQL 1.8%Language:JavaScript 0.2%Language:CSS 0.2%Language:Dockerfile 0.1%