Skip to content

Latest commit

 

History

History
80 lines (59 loc) · 2.67 KB

README.md

File metadata and controls

80 lines (59 loc) · 2.67 KB
Raw

Keep The Change

YHack 2016 Project

Keep The Change aims to solve the evolving issue of controlling the seductive nature of getting everything you want shipped in 2 days via Amazon. It helps students create a budget for themselves and blocking the checkout when this budget is exceeded. It will also recommend cheaper alternative to items (such as AmazonBasics over brand names).

Requirements

Getting Started

Keep The Change is a Python Flask app and a Chrome extension.

Start by setting the constants in amazonkeys.py to match your Amazon Associates and Advertising API accounts.

To run the Flask app, create a virtualenv, then run the following:

pip install -r requirements.txt
python ktc.py

Amazon

A component of Keep The Change is helping students find cheaper alternatives to products users purchase on Amazon.

GET /amazon/B000OOYECC - Get name, price, and cheaper alternative to ASIN B000OOYECC.

Example: https://keepthechange.herokuapp.com/amazon/B000OOYECC.

Supported RESTful operations

Until we implement authentication, the user ID is not taken into account. Just use user 1 for now.

GET /user/1 - Get all information of user 1

GET /user/1/transactions - Get the list of transactions of user 1

POST /user/1/total_budget - Update user 1's budget. Expects raw JSON as request body.

Sample request body:

[
    {
        "category": "Food",
        "percentage": 30.0
    },
    {
        "category": "Electronics",
        "percentage": 5.0
    },
    {
        "category": "Textbooks",
        "percentage": 25.0
    },
    {
        "category": "Clothes",
        "percentage": 25.0
    },
    {
        "category": "Misc",
        "percentage": 15.0
    }
]

POST /user/1/transactions - Insert a transaction for user 1 (encoded form data: company, cost, date, and category)

Sample request body:

category=food&cost=6&company=Chick+fil-A&date=2016-11-12

DELETE /user/1/transactions/9876554 - Delete transaction 9876554 from user 1

The expected success response for all queries is a JSON document with a 200 OK status code.

Try it out

Keep The Change is available at https://keepthechange.herokuapp.com/.