Contributing

AirTrail is an open-source project, and contributions of every kind are welcome.

Reporting issuesCopy Anchor Link

If you find a bug, open an issue on GitHub. Search the existing issues first. A good report includes:

• The AirTrail version (shown next to the title in Settings, or run airtrail-admin version).
• How you installed it (Docker Compose, Portainer, manual, and so on).
• What you did, what you expected, and what happened instead.
• Relevant log output, for example from docker compose logs airtrail.

Suggestions and feedbackCopy Anchor Link

For ideas and questions, start a discussion.

Contributing codeCopy Anchor Link

Open an issue before starting on a larger change, so the approach can be agreed first.

To run AirTrail locally for development:

1. Clone the repository and copy .env.example to .env.
2. In .env, set ORIGIN to http://localhost:5173 and change db to localhost in DB_URL.
3. Run bun setup to install dependencies, start the database, run the migrations and start the app.
4. Afterwards, bun d starts the app. Open http://localhost:5173 and sign in as test with password password.

Pull requests use Conventional Commits titles. The full guidelines, including code style and the review process, are in CONTRIBUTING.md.