creditflow

A digital ledger app for managing credit and debit transactions, enabling users to easily track payments, monitor balances, and stay on top of their finances.

Prerequisites

Server (Java Spring Boot):

• Java Development Kit (JDK): Download Link (version 21 or later recommended)
• Maven: Download Link
• Postgres

Client (React):

• Node.js: Download Link
• npm, pnpm or yarn (preffered)

Running the Application

1. Clone this repository:

• Using Git

 git clone https://github.com/SabarishAV/creditflow.git

• Download as zip and extract: Download Link

2. Server (Backend):

1. Open a terminal window and navigate to the "server" directory.

 cd ./server

2. Set environment variables:
   Run this command in your terminal to set environment variables
   • For Windows

   $env:DB_USERNAME="database_name"
   $env:DB_PASSWORD="database_password"
   $env:DB_HOST="database_host for local localhost"
   $env:DB_PORT="database_port usually 5432"
   $env:DB_NAME="database_name"

   To confirm the environment variables are set, you can use:

   echo $env:DB_USERNAME
   echo $env:DB_PASSWORD
   echo $env:DB_HOST
   echo $env:DB_PORT
   echo $env:DB_NAME

   • For Linux and MacOs

   export DB_USERNAME="database_name"
   export DB_PASSWORD="database_password"
   export DB_HOST="database_host for local localhost"
   export DB_PORT="database_port usually 5432"
   export DB_NAME="database_name"

   To confirm the environment variables are set, you can use:

   echo $DB_USERNAME
   echo $DB_PASSWORD
   echo $DB_HOST
   echo $DB_PORT
   echo $DB_NAME

3. Run the following command to start the Spring Boot application:
• To run server directly

mvn spring-boot:run

OR

• To compile and run the app (OPTIONAL)

Compile using:

mvn clean package -DskipTests

Run the compiled app using:

java -jar target/creditflow-0.0.1-SNAPSHOT.jar

4. You can see the server running at port 8080

3. Client (Frontend):

1. Open a terminal window and navigate to the "client" directory.

 cd ./client

2. Set environment variables
• Run this command to create .env file

 cp .env.example .env

• Change the url to backend server url
3. Install all dependencies and run the app:
• If using npm

npm install
npm run dev

• If using pnpm

pnpm install
pnpm dev

• If using yarn (preffered)

yarn install
yarn dev

4. You can see the frontend app running at port 5173