Finances Tracker

This is a simple finances tracker that I use to keep track of my finances.

Warning

Development on this project has been stopped in favour of Next-Finances!
Next-Finances is the NextJS-based successor to this project.

Getting started

1. Set up the .env file. Therefor a sample is uploaded to the repository. Just copy the .env.sample file to .env and change the values to your needs. The values are used to configure the application and the database connection.

   cp .env-sample .env

2. Start the PostgreSQL database. It will be the backbone of our application and locally available on port 5432. The setup is provided using docker. The credentials can be found in the docker-compose.yaml file.

   cd docker/finances-dev
   docker compose up -d
   cd ../..

3. Install the npm dependencies:

   npm install

4. After installing the dependencies, you need to apply the database migrations and generate the prisma client. The initial migrations set up the database scheme for the Lucia authentication. Prisma then generates the client based on the database model to provide typed access to the database.

   npx prisma migrate deploy # apply the database migrations 
   npx prisma generate # generate the prisma client

5. Finally, start the development server:

   npm run dev

6. To access the application, open the following URL in your browser: http://localhost:3000 Create an account to access the application. On the account page, you can generate some sample data. Now explore the application and customize it to your needs.

Deployment

The application is deployed using docker. The docker-compose.yaml file contains the configuration for the application and the database. The application is available through an external traefik reverse proxy. The traefik configuration is not part of this repository.

To deploy the application, the image for the SvelteKit app is built and exported. The image, docker-compose.yaml and .env file form 'docker/finances-prod/' is then copied to the remote server, where the image is loaded and the application is started.

The docker-compose file uses the image with the :latest tag. This is automatically set to the uploaded image when the image is loaded. Notice: This leads to a stack of images from previous version on the remote server!

The described steps are already automated in the deploy.sh script. The commands for the remote host are defined in deploy-remote.sh. To adapt the scripts to your needs, you need to change the variables in the beginning of the deploy.sh script. The used image version can be set as a script parameter.

Make sure to change the database credentials and the correct ORIGIN variable in the .env file before deploying. The ORIGIN has to be the exact URL of the application. Otherwise, the application will not work properly!

To deploy the application, run the following command:

  # don't run this command with sudo to use the ssh keys of the current user
  sh ./deploy.sh x.x.x