Starting point

MyFin is a self-hosted solution. That means that in order for you to use the frontends (android or web) you need to first setup and launch your own instance of the API in your own server. You can find instructions on how to do that in the wiki.

You can get started using MyFin in one of 2 ways:

• Through Docker or Docker Compose
• Manually installing the api and frontend in your web server/machine

Docker

We provide the following docker images:

• myfin-api - docker image for the API, hosted by ghcr.io
• myfin - docker image for the web frontend, hosted by ghcr.io

We also maintain a docker-compose config you can use to bootstrap the whole platform (api + web) by simply running:

docker compose up

Manual installation

Initial Setup

1. Upload this project into your server (using git clone is the recommended path)
2. At the root directory, create a new .env file (you can use the provided .env.example as a starting point). There, you need to set the URL endpoint to your API instance.

VITE_MYFIN_BASE_API_URL=https://api.querty.xyz/; # PUT YOUR API INSTANCE BASE URL HERE

3. Install the dependencies

npm install

4. Build the app

npm run build

5. Make the necessary web server changes to set a custom document root for the domain:

<PROJECT_ROOT>/dist

Updating

1. Update the project files

git pull

2. Install the dependencies

npm install

3. Build the app

npm run build