Reckless Saturn

Famished gives restaurants with available seating immediate access to hungry customers. Currently, Famished can be downloaded as a mobile application for iOS and android.

Team

• Product Owner: Armando Perez (armandopmj)
• Scrum Master: Ly Mai Le (lmle)
• Development Team Members: David Nguyen (blankmaker), Eddie Jimenez (phoenix16t)

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

1. First download Famished from the Google play store, apple store or our website (websiteName.com) (todo)

2. After downloading and automatic installation sign up for an account as a Customer or Restaurant.

   Customer Usage

   1. Login into your account and fill out the search criteria to match the type of restaurant you would like to eat at.

   2. Once all fields are filled out click submit.

   3. A list of restaurants with available seating will be displayed. Select the the few you would like to eat at and wait for the one who conforms the quickest.

   4. Once a conformation is received the restaurant will be expecting you so head on over and enjoy your meal!

   Restaurant Usage

   1. Login into your account and whenever there are tables open swipe the available button.

   2. Interested customers and their party size will be displayed on your screen in real time. Select a customer to send them a conformation.

   3. Once a customer has been selected they will be notified and will arrive momentarily.

Requirements

• Node 0.10.6
• Bower 1.3.9
• MySQL 5.6.20
• Ionic 1.1.13
• Java 7.0.67 (For android deployment)
• ADT (For android deployment)
• Android SDK (For android deployment)
• Xcode 5.1.1 (For iOS deployment)

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

From within the /client directory:

npm install
bower install

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.