Skip to content
Trakli Docs

How to contribute

Trakli is open source. Contributions are welcome, whether that is code, documentation, bug reports, or translations. This page explains how to get involved.

The open-source ethos

Section titled “The open-source ethos”

Trakli exists because personal finance tooling should be inspectable, ownable, and self-hostable. You can read every line, run it on your own machine, and keep your data under your own auth. Contributions keep it that way: open, honest about what it does, and useful to people who want control of their money without spreadsheet labour.

Ways to help

Section titled “Ways to help”
  • Report bugs. A clear issue with steps to reproduce is genuinely valuable.
  • Improve docs. If something here was unclear or wrong, a fix helps the next reader.
  • Write code. Pick up an open issue, or propose a change and discuss it first.
  • Translate. The apps support several languages and welcome more.

Project layout

Section titled “Project layout”

Trakli is one repository with three parts:

  • webservice/: the Laravel backend, the API, and the agent.
  • ui/: the Nuxt web dashboard.
  • mobile/: the Flutter app for Android and iOS.

The agent capability is built on a separate open package, eloquent-agents, which provides the tool-calling and authorization layer.

Getting set up

Section titled “Getting set up”

Each part has its own setup. The self-hosting guide is the fastest way to a running stack:

Before you open a pull request

Section titled “Before you open a pull request”
  • Keep changes focused. One concern per pull request is easier to review.
  • Run the tests for the part you changed: php artisan test for the backend, npm run test for the web UI, flutter test for mobile.
  • Match the existing style of the code you are editing.
  • For a new capability, describe the user-facing outcome, not just the mechanics.

Where to find us

Section titled “Where to find us”

The source, issues, and contribution guidelines live on GitHub.