joepeacock001 / Fresh-Fridge

Have you ever forgotten about food in your fridge, and it was just left there to rot? With Fresh Fridge, you won't have to remember the expiration dates to all of your foods!

#What is Fresh Fridge? Fresh Fridge is an open source project that strives to create a mobile app that will provide an easier and more efficient way to keep track of groceries and their expiration dates.

#Mission Statement To create, as a community, a mobile application that will provide an easier and more efficient way to keep track of groceries and their expiration dates.

#Goals

• Create a list of items in your refrigerator with their respective expiration dates
• Receive push notifications about when certain foods are about to expire
• Ability to create grocery lists from within the application

#Stretch Goals

• Availability on multiple platforms (Will only be available for Android at first)
• Recipe database that shows what food can be made with the items that you have
• Ability to scan barcodes for expiration date and food information
• "Tips" page that gives the user suggestions on how to make food last longer and seasonal
  foods
• Synchronization of list between multiple phones within a household

#Requirements

• Ionic framework
• Angular JS
• Any web browser
• Eclipse for Android Development

#Development Status

• Version 0.1 (beta)
• Follow us for updates
  • Website: http://freshfridgeoss.wix.com/fresh-fridge
  • Facebook: https://www.facebook.com/freshfridgeOSS
  • Twitter: https://twitter.com/FreshFridgeOSS

#Ways You Can Contribute We would love any help you can give us on the application. There are always ways you can contribute!

• Front-end Developers:
  • Using Eclipse's XML GUI, you can help us with our UI and icon design. Help us make our application fun and easy to use.
  • For resources on how to use XML: http://developer.android.com/guide/topics/ui/declaring-layout.html
• Back-end Developers:
  • Using Eclipse/Java/SQL, you can help us with data entry, database setup, activity flow and feature additions.
  • For resources on how to use Java for Android:
    • http://code.tutsplus.com/tutorials/learn-java-for-android-development-introduction-to-java--mobile-2604
    • http://www.tutorialspoint.com/android/
• Food Researchers:
• Research is a large part of our app. We need help with fact checking such as typical food expiration, seasonal foods, and recipes.
• Bug Checkers:
  • Test out the app or take a look at ways the code can be improved. Then, report suggestions or bugs on the issue page.
• Feature Ideas:
  • Let us know what we can do to improve are application, or if you have an idea you would like to improve upon, then fork our repository, create a branch, and create a pull request with your changes

#Step-by-Step Setup

1. Install eclipse at https://developer.android.com/sdk/index.html?hl=i
2. Fork the Fresh Fridge repo
3. Clone the Fresh Fridge repo to your remote repository
4. Import the base project, take src and res files and replace the original files with the updated files
5. Create a branch with your changes
6. Make a pull request with changes

#Errors in the Project

• If you find you have errors concerning the appcompatv7 plug-in upon importing the project, follow these steps to resolve:

1. Import appcompat v7 into workspace (located in android sdk >extras> android> support folder)
2. Right click on the project, go to properties, click on Android
3. Under library, click add, then click on appcompat v7

• If you have errors on xml (e.g. missing styles):

1. Click on main screen tab and go to customactionbartheme

#Documentation

• Comment on each section of code to make sure it's clear
• Title your commits after the issue number
• Please be courteous when posting in forums or chat rooms

#Governing Guidelines

• What is the current governing style for Fresh Fridge?
• Currently our group consists of 3 developers, so we run on a democracy styled system. If there is a large change that needs to be made, we bring it up in the forum. If there is a divide in the decision making process, we hold vote amongst the developers.
• What happens when more developers get involved?
• Once you have made a significant contribution to the Fresh Fridge application, you can inquire about being a part of the governing team. This will give you the opportunity to vote on major application changes, take on a larger role in the authoritative process, and have full push access to our repo.

#Forum Guidelines

• What should I post in the forum?

• Questions

• Comments

• Feature Ideas

• You may post application bugs in the forum for discussion, but please be sure to post these directly to the repo issues page for further consideration.

• How should I format my forum post?

• Clear header/subject line

• Clear explanation of your request and/or comment

• What should I NOT include in my forum post?

• Vulgar language

• Rude comments

• Ads

• Explicit content

#License Fresh Fridge is licensed under the GNU General Public License. For more information, read the license file in the Fresh Fridge repository.

#Contributors

• Jennifer Re
  • https://github.com/jenre6
• Danny Corona
  • https://github.com/coron108
• Sabrina Chapman
  • https://github.com/chapm151