OxiLedger

An application made for tracking personal finances. Built with Dioxus and Axum.

Running

This project is primarily designed to run with Docker.

Configuration

OxiLedger uses environment variables for configuration. They are defined as follows:

Variable	Description	Default
DATABASE_URL	The URL for the PostgreSQL database.	required
OIDC_N_ISSUER	OIDC issuer URL for authentication.	null
OIDC_N_CLIENT_ID	OIDC client ID for authentication.	null
OIDC_N_CLIENT_SECRET	OIDC client secret for authentication.	null
OIDC_N_NAME	Display name for the OIDC provider.	null
DISABLE_PASSWORD_LOGIN	If set to true, disables password-based login.	false
BASE_URL	The base URL for the application, used in OIDC redirect URIs.	null

Replace N in the OIDC variables with a number (e.g. OIDC_1_ISSUER) to configure one or multiple OIDC providers.

Development

To get started, install Rust, dioxus-cli, and sqlx-cli.

Serving

Run the following command in the root of your project to start developing with the default platform:

dx serve --platform web

To run for a different platform, use the --platform platform flag. E.g.

dx serve --platform desktop

Preparing Database Files

When building the Docker image, SQLx needs to run in offline mode. This requires prepared files, which can be generated with the following command:

cargo sqlx prepare --workspace -- --features server

Contributing

This is a personal hobby project, but contributions are welcome! If you have an idea for a feature or improvement, feel free to open an issue or submit a pull request.

AI Use

Using AI to generate code is permitted, but you MUST review and understand any AI-generated code before submitting it. Any PRs containing AI-generated code that has not been human-reviewed will be rejected.