https://github.com/m-thalmann/actual-dashboard
An unofficial basic dashboard to show information about some Actual Budget accounts
https://github.com/m-thalmann/actual-dashboard
actual-budget angular api-rest
Last synced: 11 months ago
JSON representation
An unofficial basic dashboard to show information about some Actual Budget accounts
- Host: GitHub
- URL: https://github.com/m-thalmann/actual-dashboard
- Owner: m-thalmann
- License: mit
- Created: 2024-09-11T16:37:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-22T18:08:51.000Z (over 1 year ago)
- Last Synced: 2024-11-22T19:21:06.923Z (over 1 year ago)
- Topics: actual-budget, angular, api-rest
- Language: TypeScript
- Homepage:
- Size: 1.29 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Actual Dashboard
## Dev Setup
1. Install the dependencies: `npm install`
1. Copy the `.env.example` file to `.env` within the `apps/backend` folder
1. 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
1. Start the backend: `npx nx serve backend`
1. 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
1. Copy the `.env.docker` file to `.env`
1. Set the environment variables in the `.env` file
1. Run the `docker compose up -d` command
1. Access the dashboard at http://localhost:3000