https://github.com/chanda-abdul/easy-budget-app-api

API for my Thinkful full-stack capstone project
https://github.com/chanda-abdul/easy-budget-app-api

Last synced: 2 days ago
JSON representation

API for my Thinkful full-stack capstone project

• Host: GitHub
• URL: https://github.com/chanda-abdul/easy-budget-app-api
• Owner: Chanda-Abdul
• Created: 2020-05-17T23:37:19.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T02:35:55.000Z (almost 2 years ago)
• Last Synced: 2023-03-04T21:31:38.115Z (over 1 year ago)
• Language: JavaScript
• Homepage: https://fast-garden-40399.herokuapp.com
• Size: 787 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Thinkful Full Stack Capstone - Easy Budget App API Server

## Programmer

Chanda Hubbard

## Summary

While enrolled in Thinkful's Web Development bootcamp I created this full stack Capstone project.  Easy budget is an interactive web application that was created to view and manage your monthly budget.  This app was created so that you can view all of your monthly expenses and figure out whether they align with your financial goals.

## Easy Budget Server

Link to the [Live heroku server](https://fast-garden-40399.herokuapp.com/)

## Easy Budget Client

Link to the [Client Repo](https://github.com/ChandaHubbard/Easy-Budget-Client)

## Technology Used

#### Front-end

- React

    - Router

    - Context

    - Libraries

        - Sweet Alerts

- HTML

- CSS

- Vercel(Zeit)

#### Back-end

- Node.js

- Express

    - Knex

    - Mocha, Chai & Supertest

    - Morgan, CORS, Helmet

- PostgreSQL

    - Elephant SQL

- Heroku

# 

# Easy Budget API

- Easy Budget's back-end consists of an API server that was created with Node.js, Express, Knex, and PostgreSQL

 

- Easy Budget's API service consists of `/GET` `/DELETE` `/POST` and `/PATCH` endpoints

- The API was created locally and deployed to heroku.  The API can be accessed through heroku 

[here](https://fast-garden-40399.herokuapp.com/).

### /GET at `/expenses`

The user can access the `/GET` endpoint through the client by visiting the `/budget` page and all expenses will be displayed.  The `/GET` endpoint can also be accessed at `/expenses` on the back-end through the heroku server at [https://fast-garden-40399.herokuapp.com/expenses](https://fast-garden-40399.herokuapp.com/expenses).

### /GET at `/expenses/:id`

The `/GET/:id` endpoint can be accessed at `/expenses/:id` on the back-end through the heroku server at [https://fast-garden-40399.herokuapp.com/expenses/:id](https://fast-garden-40399.herokuapp.com/expenses/75).

### /DELETE at `/expenses/:id`

The `/DELETE` endpoint is used to delete specific expenses by id. The user can access the `/DELETE` endpoint through the client by visiting the `/budget` page and selecting the Delete button next to the expense that they would like to delete.  The `/DELETE` endpoint can also be accessed at `/expenses` on the back-end through the heroku server at [https://fast-garden-40399.herokuapp.com/expenses](https://fast-garden-40399.herokuapp.com/expenses).

### /POST at `/expenses`

The user can access the `/POST` endpoint through the client by visiting the `/create` page and filling out the form then selecting the Add Expense button.  The `/POST` endpoint can also be accessed at `/expenses` on the back-end through the heroku server at [https://fast-garden-40399.herokuapp.com/expenses](https://fast-garden-40399.herokuapp.com/expenses).

### /PATCH at `/expenses/:id`

The `/PATCH/:id` is used to update specifc expenses by id and the endpoint can be accessed at `/expenses/:id` on the back-end through the heroku server at [https://fast-garden-40399.herokuapp.com/expenses/:id](https://fast-garden-40399.herokuapp.com/expenses/75).

# 

### Easy Budget's API service consists of data that is stored in a PostgreSQL database

# 

- The database creation scripts can be found at `/migrations`

- The database is initially seeded with data that can be found at `/scripts/seeds`

- Both tables are hosted remotely on ElephantSQL and can be accessed 

[here](postgres://ymzzpjmz:[email protected]:5432/ymzzpjmz)

- The PostgreSQL database consists of two tables 

    - budget_expenses 

    

    - expense_type 

    

    - The tables share the relation of `expense_type(id)/budget_expenses(type_id)` and can be joined with the PostgreSQL query of 


````

SELECT budget_expenses.id, name, amount, type, category, date

FROM budget_expenses

INNER JOIN expense_type

ON (budget_expenses.type_id = expense_type.id);

````







# 

## Other features to implement in future versions

[ ] Incorporate the `/PATCH` endpoint into the client.