Skip to content

An Android app hooked up to the Edamam Recipe API, Firebase for user auth and data persistence.

Notifications You must be signed in to change notification settings

rossfletcher19/CuisineCatalog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cuisine Catalog

An Archive of Recipes and Reviews of Food built in Android Studio. How good is food!?!, 03/16/2018

By Ross Fletcher

Specs

Behaviour Input Output Status
A user can view a homepage with about/bio and drawer menu with user profile features, saved recipes, and a leave feedback path User views main activity User sees main activity page with about/bio section and drawer menu features, user profile features, saved recipes, and a leave feedback path Done
A user can view a list of recipes from the edamam api, site created recipes, and their saved recipes. User selects specific cuisine from cuisine list activity User sees list of recipes within that cuisine Done
A user can see input/reviews of a recipe User clicks on a recipe User sees recipe, along with comments and reviews on the recipe Not Done
A user can login or create an account with account info through Firebase. User opens app User arrives at login feature to register a user name and pw or login with previously created user name and pw Done
A admin can login and add, edit or delete a recipe Admin visits admin area and logs in Admin sees list of all recipes and posts and has ability to edit or delete recipes/posts Note Done
A user can reorder their favs/saved list User selects and drags favorite Favorite is added to list in new position and order Done
A user can remove a recipe from their favs/saved list with swipe gesture User swipes favorite list item Favorite list item is removed from list Done

Setup/Installation Requirements

  • Clone or fork project

Firebase Setup

  • If you dont have a firebase account create one @Firebase, create a new project, assigning it the SHA-1 key found in the signing report pictured here
  • Place the google-services.json in the app module root directory.
  • Re-sync project with gradle and move onto API setup.

API Setup

  • Create a free developer account for the Recipe Search API at @Edamam
  • Create a gradle.properies file in the CuisinCatalog project directory and place your ID and KEY in the format below.
  • Use Android Studio to let project gradle build and then create a new virtual device with AVD manager
  • Run app on virtual device, let the emulator start up to display the app.
EdamamId = "id"
EdamamKey = "key"

UX/UI

  • Develop custom style

Polish

  • Refactor
  • Delete unused
  • Make README awesome

Known Bugs

none currently

Support and contact details

Contact Ross Fletcher @ rtbfletch at outlook dot com, with any questions or input and thank you!

Technologies Used

  • Android Studio
  • Java
  • Android Virtual Device Manager
  • Git and GitHub

License

Copyright (c) 2018 Ross Fletcher

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

An Android app hooked up to the Edamam Recipe API, Firebase for user auth and data persistence.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages