testing's Introduction

kaching backend

A backend application for kaching personal finance tracker to track monthly expenses and budgets based on day, month or year. Project 3 for Rocket Academy Bootcamp

Features

Add new users or check for existing users in the database
Add, edit, and delete transactions/budgets/categories database created by user
Get users informations such as categories, transactions, budgets and etc...

Tech Used

Backend: Node.js, Express.js, Sequelize
Database: PostgreSQL

Setup

Before starting, it is required to run the following steps for the application to work. Make sure you have all the necessary software before running this

Clone repo to local
Configure .env file, make sure to get your own API keys stated below and insert it into your .env file
- If unsure where to get API keys, refer to the Tech Used for the documents

PORT = <Insert PORT number for your backend, e.g. 8080>
USERNAME = <PostgreSQL username, e.g. postgres>
PASSWORD = <Insert password if exist>
DATABASE = <Insert database name, e.g. kaching>
HOST = localhost
DIALECT = <Insert dialect, for this app is postgres>
SENDGRID_API_KEY = <Insert SENDGRID API key>

Install all dependencies required in this repo

npm i

Next run database migration, and seeders before starting. Make sure no error.

npx sequelize db:create
npx sequelize db:migrate
npx sequelize db:seed:all

Once done, run either one of the command below to run

node index.js
nodemon index.js

Enjoy! You can use postman to test out the requests

Future improvements

More functions/routers to make better requests such as querying dates
Add functions for task scheduling, to automatically send email and notifications to the user to remind them to pay their bills