Skip to content

An unofficial basic dashboard to show information about some Actual Budget accounts

License

Notifications You must be signed in to change notification settings

m-thalmann/actual-dashboard

Repository files navigation

Actual Dashboard

Dev Setup

  1. Install the dependencies: npm install
  2. Copy the .env.example file to .env within the apps/backend folder
  3. Start a development Actual server using docker: npm run actual-server
    • Open the Actual client: http://localhost:5555
    • Set a server password
    • Create an empty budget file (or import one of yours)
    • Update the server url, password and sync id (Settings → Advanced settings) in the .env file
    • Fill it with some data
    • Note: The data is persisted to the local /tmp/container-data folder
  4. Start the backend: npx nx serve backend
  5. Start the frontend: npx nx serve frontend

API Documentation: http://localhost:3000/docs

Production Build

npx nx run-many -t build

Deploy with Docker

  1. Navigate to the docker directory
  2. Copy the .env.docker file to .env
  3. Set the environment variables in the .env file
  4. Run the docker compose up -d command
  5. Access the dashboard at http://localhost:3000

About

An unofficial basic dashboard to show information about some Actual Budget accounts

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published