HTTPS SSH

Break Bread with Friends

Website

https://break-bread.herokuapp.com/

What is this repository for?

Break Bread is a web application that allows a visitor to preorder foods and reserve a table at a restaurant. The restaurant managers can decide which reservations to take through a queue system.

  • Version 1.0

Video Walkthrough

Here's a walkthrough of implemented user stories:

Alt text

How do I get set up?

  • Summary of set up
    • Django
./manage.py runserver
  • Sphinx Documentation

    • in docs/, run this command and access the file mysite/docs/_build/html/index.html:
make html
  • Dependencies
pip install -r requirements.txt
  • Database configuration
    • SQLite
  • How to run integration and unit tests
coverage run --source="." manage.py test customerApp restaurantApp
coverage report
  • How to run acceptance tests
./manage.py test acceptance_tests.restaurant_acceptance_test
./manage.py test acceptance_tests.customer_acceptance_test
  • Pylint
pylint --generated-members=objects customerApp restaurantApp
  • Deployment
git push heroku master

API Integrations

  • Yelp
  • Stripe
  • Twilio

Contributors

  • Scrum Master: Christopher Yang
  • Product Owner: Stephanie Marie Fan
  • Porrith Suong
  • Joseph Fan