sage-t / Recipist

RoR app that takes ingredients that you have and returns recipes that you could make.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Project Recipist [Final Submission]

People

  • Sage Thomas - ScienceSage
  • Burak Karaoglu- mbkaraoglu
  • Amulya Srivastava - amsr2031
  • Victoria Soesanto - viso4661
  • Qiu Duan - qidu0919

Repo Organization

  • /Acceptance Tests/ contains tests and links to other tests
  • /Recipist Android App/ contains the main stable source for the Android app
  • /Recipist Web App/ contains the Rails app and a small README describing it
  • /Server/database_builder/ contains a script to make the db file for the API
  • /Server/heroku/ contains the Flask API and db file that runs on heroku
  • /Server/old_server/ contains the old test Flask API
  • /Server/recipe_web_crawler/ contains a web crawler script that aggregates recipes from the internet to be used in the API
  • /src/ contains the old Android App source

Testing

Testing can be found in the /Acceptance Tests/ directory

Description

Recipist is a Web and Android application that helps college students find recipes to make using the ingredients that they currently have. The app records

Vision Statement

Make cooking less of a chore by reducing trips to the grocery store.

See for yourself

Motivation

We have the issue of not knowing what food we can make with the ingredients on hand most nights a week. This app will help us alleviate some of our pain by searching for and displaying a diversity of food to make.

Risks

  • Most of us don’t know each other
  • Different schedules so team meetings are difficult
  • Most of us don’t know Java or SQL
  • Never built a phone app
  • Most have never worked on project this large

Mitigation strategies

  • Get to know each other better (try for more in person meetings)
  • Specialization of languages
    • Two sub-groups
      • One for backend (python, SQL)
      • One for frontend (Java)
  • Do research on how android app architecture works
  • Learn (at least basics of) relevant languages before starting
  • Keep good contact using slack.

Agile User Stories

As a developer, I want to have a database to store recipes so that I can query recipes

  • ID: 1 Size: 5

As a developer, I want an app layout so that I can have a plan for developing the app

  • ID: 2 Size: 3

As a user, I want to be able to save recipes so that I can view them later

  • ID: 3 Size: 5

As a user, I want to save a list of my ingredients so that I don’t have to enter them later

  • ID: 4 Size: 5

As a student, I want a search bar for recipes or ingredients so I can easily find them.

  • ID: 5 Size: 8

As a developer, I want a search function so I can search recipes with a query

  • ID: 6 Size: 8

Methodology

We are using the Agile development

Project Plan

See Github Issues & Milestones

About

RoR app that takes ingredients that you have and returns recipes that you could make.


Languages

Language:Ruby 37.5%Language:Java 23.3%Language:Python 21.0%Language:HTML 14.1%Language:CSS 2.1%Language:JavaScript 1.7%Language:CoffeeScript 0.3%