Finance Tracker

Simple tool to monitor bank accounts with cool statistics

Installation

To install Finance Tracker locally, the easiest method is using the GitHub-built Docker Container. This can be done by using these commands:

docker pull ghcr.io/av32000/finance-tracker:latest
docker run -p 3000:3000 -e FT_HOST=0.0.0.0 -e FT_PORT=3000 -e FT_STANDALONE=true ghcr.io/av32000/finance-tracker:latest

Building from source

To build Finance Tracker from source, you can clone the repo with the following commands:

git clone https://github.com/Av32000/Finance-Tracker
cd Finance-Tracker

After these steps, you have two options:

Docker Hosting

Using Docker is the easiest method to run Finance Tracker. Docker Compose will create, set up, and host a PostgreSQL database without additional configuration steps.

To use Docker Compose hosting, run the following commands:

POSTGRES_PASSWORD="<your_password>" # Replace this with a custom password for the database
echo -e "POSTGRES_USER=postgres\nPOSTGRES_PASSWORD=$POSTGRES_PASSWORD\nPOSTGRES_DB=ft" >> .env
docker compose --env-file .env up

You're ready to open http://localhost:3000 and start using Finance Tracker.

Classic Hosting

It's possible to run Finance Tracker without using a Docker container. First, you need to set up a PostgreSQL database and obtain a connection string. Then, you can run the following commands:

# Setup env variables
DATABASE_URL="<your_connection_string>" # Replace this with the connection string of your PostgreSQL database
echo "DATABASE_URL=$DATABASE_URL" >> .env

# Install dependencies
pnpm install
pnpm prisma:generate

# Build project and init database
pnpm build
pnpm prisma:push
pnpm generate-keys

# Start Finance-Tracker
pnpm start:prod

You're ready to open http://localhost:3000 and start using Finance Tracker.

Contributing

All contributions are greatly appreciated. Feel free to fork this repository and open pull requests to enhance the project.

Disclaimer

Caution

Finance Tracker is a side project and is not intended for use in production or with important or sensitive data. The authors of this software decline all responsibility for the data stored, managed, or processed by the software. Use it at your own risk.