Skip to content

montrealist/quixr

 
 

Repository files navigation

QuIxR

An app to help you decide what drinks to make!


This app will eventually allow a user to input a list of ingredients and tools they have on hand, and it will return recipes for drinks that they could create.

As of this build (1.0.1), the app provides a random recipe to check out on the home page. It then allows a user to input an ingredient to search for, and returns a list of cocktails which contain that ingredient.


QuickStart

Getting started in a flash, you have two options.

  1. Sign up to be a patreon supporter of thecocktaildb to get an api key (recommended) or
  2. install the provided database file (swap username with your username)

Option 1: Becoming a patreon supporter

Good choice. We should all be supporting one another. Also, you'll always get the most up to date database this way.

  1. You should install everything in the requirements.txt

pip install -r requirements.txt

  1. Then you should create a seperate file for your api key. Import it into front_loader.py replacing line 3 with whatever your import should be. NOTE: import your api key as 'api_key' to not have to change anything else

  2. Set-up your database. You can do this by either creating your database as you like and setting your environement variable to 'DATABASE_URL' or creating a postgresql database and naming it 'quixr'.

  3. You should then run front_loader.py

python front_loader.py

  1. At this point, your app is ready to launch, either via:

flask run access at 127.0.0.1:5000

or setting it up on a host.

Option 2: Using the provided database file

  1. Load the preloaded database in

psql -U postgres quixr < dbexport.pgsql

postgres is usually the default username that installs with postgres. If you've set up your postgres to use a different username, insert it here.

  1. create a virtual environment (highly recommended, not 100% necessary) run it

python -m venv venv
python might actually be python3 depending on your system In mac/linux, running your virtual environemnt is: . venv/bin/activate In windows: source venv/bin/activate

  1. Install the required frameworks and tools:

pip install -r requirements.txt

  1. Your app should be ready to run

flask run access at 127.0.0.1:5000

or set it up to be hosted.


Stretch goals might include:

  • setting up tools and ingredients that the user has, and being able to search and sort by what the user has on hand
  • implementing preferences
  • implementing a rating system
  • ability to share favorite recipes with other users, which in itself implies a forum/message board/communication method
  • search history (per user)

About

An app to help you decide what drinks to make!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PLpgSQL 91.2%
  • Python 4.2%
  • HTML 3.7%
  • Other 0.9%