dting/divvy

Hack Reactor Greenfield Project - Expense Splitting App

Divvy

Expense Splitting App

Description

Divvying up expenses between friends and peers can be a disaster. Remember that time you went on a trip and one person rented the car and another paid for dinners and a third bought the gas and the beer and then you had to even-up while accounting for tips? Or that time rent was due but someone had purchased all of the groceries and utilities for the month? Enter Divvy.

Divvy allows users to enter expenses as they are incurred, and calculates the best way to settle the bill. No more painful math and messy payments to different people, Divvy simplifies everything down to one payment per person.

Team

• Product Owner: Hannah Henderson
• Scrum Master: James Ramadan
• Development Team Members: Dennis Ting, Wayne Adams

Tech Stack

Server

• Node - v6.3.0
• Sequelize - ORM for defining app data relationships and managing queries.
• Express - Server with convenient routing and large collection of middleware packages to handle requests.

Client

• Angular - MV* framework to build readable, maintainable, and testable client interface to our app. The app may be reviewed by another group as a legacy project.

Development tools

• Gulp - Task runner to automate and simplify development, build, and deployment processes.

Table of Contents

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

Requirements

• Node 6.3.0
• NPM 3.10.3

Development

Installing Dependencies

1. Run npm install from the command line.
2. Run bower install from the command line.

Setting Up passport-facebook

1. Sign up to be a Facebook developer.
2. Click the "Create a New App" on your apps page.
3. Choose a "Website" app and give it a name.
4. Add a contact email and a category when prompted.
5. Complete the captcha and wait for the app to be created.
6. Scroll down to the "Tell us about your website" portion of the next page, enter:
   http://localhost:3000/
7. Click "Next" and scroll back to the top of the page. Click on the "Skip Quick Start" button.
8. Click the "+ Add Product" button on the left side of the dashboard.
9. Click the "Get Started" button next to "Facebook Login".
10. For "Valid OAuth redirect URIs", enter:
    http://localhost:3000/auth/facebook/callback
11. Click "Save Changes" on the bottom right.
12. Go back to the app dashboard by clicking the "Dashboard" menu item on the top left.
13. Make a copy of ./server/config/.env.sample.js as ./server/config/.env.js. Notice that the .env.js file is a JavaScript file. The value for each property of the exported object in this file should be a string. Make sure there are single quotes around the pasted in values.
14. Copy the "App ID" and replace FACEBOOK_ID's value with the copied value.
15. Click the "Show" button for "App Secret". Enter your Facebook password to display the value. Copy the shown value and into the .env.js file as the FACEBOOK_SECRET.
16. With the dev server running, navigating to http://localhost:3000/auth/facebook redirects the browser to Facebook and ask for app authorization. Once authorized, the browser redirects to http://localhost:3000/auth/facebook/callback with a code query param (logged on the server). The browser then redirects to the application root.

Deployment (Heroku)

Assumes user has a developer account with Heroku. Accounts are free to create for up to five projects.

1. Run gulp build from the root directory.
2. Change directory to the "dist" folder.
3. Create a deployment remote using Heroku Create.
4. Use the Heroku dashboard to view new remote. Can change the app name at this step. Reset remote path name using git remote set-url heroku https://git.heroku/APPNAME.git
5. Select current project and navigate to "settings". Click on "Reveal config vars".
6. Populate keys for NODE_ENV, DOMAIN, SESSION_SECRET, FACEBOOK_ID, and FACEBOOK_SECRET using the information from the .env.js file. a. Set NODE_ENV equal to "deployment". b. Set DOMAIN equal to the website link generated by Heroku. Ensure there is no trailing "/". Website name will be of format https://git.heroku.com/APPNAME.git. c. Set SESSION_SECRET equal to a secure random string. http://randomkeygen.com/ d. Set FACEBOOK_ID to developer facebook ID. e. Set FACEBOOK_SECRET to developer Facebook secret.
7. Enter heroku ps:scale web=1 into the command line to ensure at least one instance is running.
8. Navigate to app within Facebook's developer tools. a. On the navigation bar (left) select "Facebook Login". Scroll down to client OAuth Settings to "Valid OAuth redirect URIs" and enter in the app DOMAIN (used above) followed by "auth/facebook/callback", likely of format https://git.heroku.com/APPNAME.git/auth/facebook/callback. Save changes. b. Under App Review (on left navigation bar), make the app public by selecting "Yes" at the top.

Roadmap

View the project roadmap here.

Contributing

See CONTRIBUTING.md for contribution guidelines.