Skip to content

software-students-fall2021/project-setup-foodwithfriends

Repository files navigation

foodwithfriends 🥗

Circle CI Build Status: Food with Friends

Check out the website at foodwithfriends.tech

Food with Friends Banner

Are you going out to eat with friends anytime soon? These friendly gatherings usually go one of two ways: a restaurant is agreed upon fairly quickly or you spend 30+ minutes choosing what to eat in the first place (not including the actual restaurant you are going to).

foodwithfriends is a web application that aims to make decision-making for where to eat easy. Users can invite their entourage to a "room" where they can choose a cuisine they prefer (e.g. Italian, Chinese, etc.), vote on it, and go on to choose a restaurant together.

Instead of wasting time deciding on what and where to eat, foodwithfriends allows you and your friends to share a meal instantly.

Product Vision Statement

Our goal is to help groups of people choose a dining spot so that more time is spent on being together than deciding on where and what to eat. To accomplish this, our MVP should allow users to create/join group spaces, vote on a cuisine and view the results, add preferred dishes related to the cuisine, and view the list of recommended restaurants in descending order (from most recommended to least, based on user preferences).

Core Team Members


Jennifer Lopez


Priya Chaganti


Sri Kaushik


Tanya Singh


Thomas Tai


Yoon Koh

History

The project is proposed by @Jen-Lopez for the Agile Development Course. She has always wanted to work on a restaurant finder application for groups, as she herself is a picky eater. There are many times where she has held up her own friend group in making decisions on where to eat. So hopefully by building this application, other picky eaters, those with dietary restrictions, or with specific cravings can find somewhere to eat relatively quick and easily.

Contribution Guidelines

If you would like to contribute to our project, we recommend you to checkout our Contributing Guidelines. Feel free to fork the project and send us a pull request.

Installation & Setup

Check out our Installation Guide to setup your local development environment.

Extra credit opportunities

Please note that we have attempted the extra credit.

We have attempted the extra credit by deploying to a Docker container. Please see the docker section of installation and setup guide for more details.

We have also attempted the extra credit using Continuous Deployment setup. On each commit to master, Circle CI will attempt to SSH into the server and run a script. The script will pull the latest repository changes, then build the docker container. Finally, each container will install dependencies and run the frontend on ports 80 and backend on port 8000.

See below for deploy.sh script:

#!/bin/bash

#path of your project on the VPS
cd ~/project-setup-foodwithfriends

#pull from the branch
git pull origin master

#kill all running docker containers
docker kill $(docker ps -q)

#go to frontend directory
cd front-end

# followed by instructions specific to your project that you used to do manually
docker run --rm -d -p 80:3000 $(docker build -q .)

cd ../back-end

docker run --rm -d -p 8000:8000 $(docker build -q .)

Additional Documentation

Releases

No releases published

Packages

No packages published

Languages