PFin-personal-finance

PFin

PFin is a personal-finance website created for user to track personal financial status include Revenue, Expense, Asset, Debt and etc. PFin allows user to add their financial record and view their financial status in a dashboard. This project is developed by using Next.js as a frontend framework. PFin API server is built by using gin as a backend framework. For backend part, we implement by using Hexagonal architecture. We also use GORM as an ORM library to interact with database. PFin is using PostgreSQL as a database. Note that this project is just for learning purpose.

Table of Contents

• Installation
• Run the app
• Pages

Installation

    git clone https://github.com/Nas-virat/PFin-personal-finance

Run the app

Setup the config file

    cd server
    touch config.yaml

Run the API server

    cd server
    go run main.go // run the server

Run the frontend server

    cd client
    npm install // install all dependencies
    npm run dev // run the server

Run swagger docs

    cd server
    swag init
    ## open the browser and go to http://localhost:8080/swagger/index.html

Pages

• Home page

In The home page, user can see the summary of their financial status. It show the total amount of revenue, expense, asset and debt. User can also see source of revenue and expense represented by pie chart.

• Revenue Expense page

In this page, user can see the list of revenue and expense. User can add new revenue and expense by clicking add button.

• Balance sheet page

In this page, user can see the list of asset and debt. User can add new asset and debt by clicking add button.