Track your financial life and keep a history of all your transactions in one place.

Technologies

Design

The design system is available on Figma.

Running the app

Clone

git clone https://github.com/bonizario/fincheck.git && cd fincheck

To clone a Git repository using the SSH protocol, an SSH key must be added to your GitHub account beforehand.

git clone git@github.com:bonizario/fincheck.git && cd fincheck

Install dependencies

Node.js is required to install dependencies and run the project.

This project uses the pnpm package manager.

npm install -g pnpm

cd api && pnpm install && cd ..

cd web && pnpm install && cd ..

Run PostgreSQL with Docker

The database can be launched locally with a Docker Container.

Check the official documentation to install the Docker Engine.

docker run --name pg -e POSTGRES_USER=root -e POSTGRES_PASSWORD=root -p 5432:5432 -d postgres

Setup environment variables

cp api/.env.example api/.env

cp web/.env.example web/.env

If PostgreSQL was started following the instructions above, there's no need to change the DATABASE_URL.

For testing purposes in a local development environment, it is okay to leave JWT_SECRET with the example value.

Note that in a real-world application, this variable must be completely secret, since all JWT authentication is based on it.

There are also specific development variables for debugging and testing React Query features on the front end.

cp web/.env.development.example web/.env.development

VITE_API_RESPONSE_SLEEP_MS simulates a delay on each API call. This makes it easier to ensure cache invalidation and loading states are handled correctly.

VITE_SHOW_REACT_QUERY_DEVTOOLS enables a FAB button that allows you to show and hide React Query devtools.

Running the back end

cd api && pnpm start:dev

Running the front end

cd web && pnpm dev

Get in touch

I intend to continue implementing new features to apply some concepts I have been studying.

If you have any questions or suggestions, feel free to get in touch!

LinkedIn: https://www.linkedin.com/in/gabriel-bonizario/