Phoodable

Phoodable is a web application that aims to help users decide a restaurant to visit by offering 2 features:

      • Regular Search: User enters term + location and relevant restaurants with their key information is returned

      • "I'm Feeling Lucky": User simply enters a location and a single restaurant with its key information is returned

Phoodable requires authentication with Facebook and uses Yelp Fusion API to help generate restaurant recommendations. Further information about this project may be found within the documentations folder of this repository.

We'll be using Django for our project, running Python 3.6

Setting up a development environment

macOS

1. Install Git if you haven't done so already
2. Clone this repo using git clone git@github.com:CS411F17/project.git
3. Get Python 3.6 for your specific OS
4. Install virtualenv; this is to avoid conflict package versions between your system python and the packages we're using for the project. Here's a good guide from Kenneth Reitz
5. Once you've finished 4, run mkvirtualenv cs411-project -p /path/to/your/python3
6. cd into this project repo
7. Run pip install -r requirements.txt; this will install all of the packages, pinned to a specific version, within the requirements file.
8. Migrate the databse schema to a sqlite file using python manage.py migrate
9. Run python manage.py runserver; your Python app will then run on localhost:8000 in your browser

Windows

1. Install Git if you haven't done so already; it runs using MINGW64
2. Open Git Bash
3. Clone this repo using git clone git@github.com:CS411F17/project.git
4. Get Python 3.6 for your specific OS
5. Install virtualenv; this is to avoid conflict package versions between your system python and the packages we're using for the project. Here's a good guide from Kenneth Reitz
6. Once you've finished 4, run mkvirtualenv cs411-project -p /path/to/your/python3
7. To workon the virtualenv, run source /path/to/virtualenv/Scripts/activate
8. cd into this project repo
9. Run pip install -r requirements.txt; this will install all of the packages, pinned to a specific version, within the requirements file.
10. Migrate the databse schema to a sqlite file using python manage.py migrate
11. Run python manage.py runserver; your Python app will then run on localhost:8000 in your browser