Financial Tracker API

Table of Contents

• About
• Requirements
• Installation
• Environment Variables
• Database Configuration
• Usage

About

This API is a financial tracker that allows users to manage their income and expenses. It provides the following functionalities:

• User registration and authentication.
• Recording income and expenses with descriptions and amounts.
• Listing, editing, and deleting financial transactions.
• Calculating and displaying financial summaries, including total income, total expenses, and balance.

The API is built using Node.js and Express.js for the backend, TypeScript for type checking, and PostgreSQL for data storage. It uses TypeORM for database operations and JWT for secure user authentication.

Requirements

Before you begin, ensure you have met the following requirements:

• Node.js: Make sure Node.js is installed on your system.
• PostgreSQL: Install and set up a PostgreSQL database for your API.
• Git: (Optional) You can use Git for version control.

Installation

Follow these steps to install and set up your API:

1. Clone the repository:

   git clone https://github.com/guerrerocing/personal-finance-tracker-api.git

2. Navigate to the project directory:

   cd personal-finance-tracker-api

3. Install the project dependencies:

   npm install

Database Configuration

Ensure your PostgreSQL database is properly set up and configured. You can use tools like pgAdmin to manage your database.

If you have Docker on your computer you can run this command tu setup your DB

    docker run --name financial-tracker-postgres --hostname postgres -p 5432:5432 \
    --volume financial-tracker-postgres:/var/lib/postgresql/data \
    -e POSTGRES_USER=tracker -e  POSTGRES_PASSWORD=admin -e POSTGRES_DB=financial-tracker \
    -d postgres:12

Environment Variables

Create a .env file in the root directory of your project to set up environment variables. Add the following variables and replace the placeholders with your database configuration:

DB_HOST=your_database_host
DB_PORT=5432
DB_USERNAME=tracker
DB_PASSWORD=admin
DB_NAME=financial-tracker

2. Export Variables:

   direnv allow

2. Run Migration:

   npm run typeorm  migration:run

Make sure to keep your .env file private and do not commit it to version control.

Usage

1. Start the API:

   npm run dev

2. Access your API at http://localhost:3000