Rice

Rice provides intelligently customized recommendations for you and your friends.

Table of Contents

1. [Usage] (#Usage)
2. Getting started
3. Clone the latest version
4. Install Dependencies
5. Setup Environment Variables
6. Start the application
7. Architecture
8. [System Diagram] (#system)
9. [Directory Layout] (#directory)
10. API Endpoints
11. [Business Service Endpoints] (#business)
12. [Users Service Endpoints] (#users)
13. [Technologies] (#Technologies)
14. [Team] (#Team)
15. [Contributing] (#Contributing)

Usage

Landing

![Landing Page] (https://cloud.githubusercontent.com/assets/8594433/17722510/6b8036c8-63e7-11e6-9c22-c0fb9198cfcb.png)

Log In or Sign Up

![Login or Signup] (https://cloud.githubusercontent.com/assets/8594433/17722507/6b7f551e-63e7-11e6-8d1f-b7442ad25a72.png)

Solo or Group

![Location] (https://cloud.githubusercontent.com/assets/8594433/17722508/6b7f740e-63e7-11e6-93f5-10059249c874.png)

Select Preferences

![Preferences] (https://cloud.githubusercontent.com/assets/8594433/17722509/6b7ffce4-63e7-11e6-970c-399c7eed41ef.png)

Review and Rating

![Ratings] (https://cloud.githubusercontent.com/assets/8594433/17723583/fd88fffc-63ef-11e6-9930-d89717868af6.png)

Getting Started

1. Clone the latest version

Start by cloning the latest version of Rice on your local machine by running:

$ git clone https://github.com/dadamaka/rice
$ cd rice

2. Install Dependencies

From within the root/static directory run the following command to install all dependencies:

$ npm install

3. Run the application

1. Start the server by running the following command from the root directory:

   $ npm start

2. Your server is now live at http://localhost:3000

Architecture

System Diagram

![alt text] (https://cloud.githubusercontent.com/assets/8594433/16996630/fe4151b8-4e66-11e6-987b-b75a767f6d35.png "Rice System Architecture")

Directory Layout

└── static
    ├── client
    │   ├── assets
    │   ├── fonts
    │   ├── public
    │   ├── src
    │   │   ├── components
    │   │   ├── containers
    │   │   ├── layouts
    │   │   ├── modules
    │   │   │   ├── Friend-View
    │   │   │   ├── Group-View
    │   │   │   ├── Home-View
    │   │   │   ├── Landing-View
    │   │   │   ├── Pref-View
    │   │   │   ├── Ratings-View
    │   │   │   ├── Restaurant-View
    │   │   │   └── SignIn-View
    │   │   ├── redux
    │   │   └── utils
    │   └── styles
    ├── node_modules
    ├── public
    │   └── externals
    │       └── apiGateway-js-sdk
    └── server
       └── server.js

API Endpoints

[Business Service Endpoints] (https://github.com/dadamaka/rice-business)

• GET /api/business/info
• GET /api/business/review
• POST /api/business/review
• GET /api/business/detail
• POST /api/business/yelp

[Users Service Endpoints] (https://github.com/dadamaka/rice-users)

• GET /api/users/users
• POST /api/users/user
• POST /api/users/user/update
• POST /api/users/friends
• POST /api/users/friends/new
• POST /api/users/preferences
• POST /api/users/preferences/update
• POST /api/users/group/preferences

Technologies

Authentication:

• Auth0
• AWS API Gateway
• AWS IAM
• AWS SDK
• SAML

Front End:

• Axios
• React Redux
• React Router
• Webpack

Styling:

• Bootstrap CSS
• SASS

Back end:

• Node.js
• Express
• AWS Lambda

Database:

• Bookshelf/Knex
• MySQL

Testing:

• Mocha
• Chai

Deployment:

• AWS EC2
• AWS RDS
• Docker
• Heroku

API:

• Yelp
• Google Maps

Microservices:

• Rice-Business
• Rice-Users
• Rice-Recommendations
• Notifcations

Team

[Dan Conger] (https://github.com/dconger)
[Dan Fiore] (https://github.com/taptapdan)
[Katherine Hao] (https://github.com/mashybuttons)
[Matt Naing] (https://github.com/mattgrisanu)

Contributing

See CONTRIBUTING.md for contribution guidelines.