104 lines
3.0 KiB
Markdown
104 lines
3.0 KiB
Markdown
<div align="center">
|
|
|
|
<img src="./Assets/logo-textmark-no-bg.png" alt="Clario Logo" width="80" />
|
|
|
|
# Clario
|
|
|
|
**A clean, fast personal finance tracker for the desktop.**
|
|
|
|
[](https://github.com/yourusername/clario)
|
|
[](https://avaloniaui.net/)
|
|
[](https://dotnet.microsoft.com/)
|
|
[](./LICENSE)
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
> ⚠️ **Clario is currently in beta.** Expect rough edges. Feedback and bug reports are welcome.
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
Clario is a native desktop app for tracking personal finances — expenses, income, and budgets — without the clutter of a browser tab. Built with [Avalonia UI](https://avaloniaui.net/), it runs natively on Windows, macOS, and Linux.
|
|
|
|
---
|
|
|
|
## Screenshots
|
|
|
|
> _Screenshots coming soon. The UI is still being polished._
|
|
|
|
<!-- Uncomment and replace when ready:
|
|
|
|
|
|
|
|
-->
|
|
|
|
---
|
|
|
|
## Features
|
|
|
|
- 📋 **Expense & income tracking** — Log transactions with categories, amounts, dates, and notes
|
|
- 📅 **Date range filtering** — Quickly slice your data by day, week, month, or custom range
|
|
- 🏷️ **Categories** — Organize transactions with custom categories and icons
|
|
- 📊 **Spending overview** — At-a-glance summaries of where your money is going
|
|
- 🌙 **Dark-first UI** — Designed for dark mode from the ground up
|
|
- 🖥️ **Cross-platform** — Runs natively on Windows, macOS, and Linux
|
|
|
|
---
|
|
|
|
## Tech Stack
|
|
|
|
| Layer | Technology |
|
|
|---|---|
|
|
| UI Framework | [Avalonia UI 11](https://avaloniaui.net/) |
|
|
| Language | C# / .NET 8 |
|
|
| Architecture | MVVM |
|
|
| Icons | [Lucide](https://lucide.dev/) |
|
|
|
|
---
|
|
|
|
## Getting Started
|
|
|
|
Download the latest release for your platform from the [Releases](https://github.com/yourusername/clario/releases) tab and run the installer.
|
|
|
|
If you'd prefer to run from source:
|
|
|
|
```bash
|
|
git clone https://github.com/yourusername/clario.git
|
|
cd clario
|
|
dotnet run --project Clario
|
|
```
|
|
|
|
> Requires the [.NET 8 SDK](https://dotnet.microsoft.com/download) when running from source.
|
|
|
|
---
|
|
|
|
## Project Status
|
|
|
|
Clario is in active development. Core tracking features work, but some things are still being built out:
|
|
|
|
- [x] Transaction entry & editing
|
|
- [x] Category management
|
|
- [x] Date range picker
|
|
- [x] Expense list with filtering
|
|
- [x] Budget goals
|
|
- [ ] Budget goal notifications
|
|
- [ ] Charts & reports
|
|
- [ ] CSV import / export
|
|
- [ ] Recurring transactions
|
|
|
|
---
|
|
|
|
## Contributing
|
|
|
|
The project isn't formally open to contributions yet while the core is still being shaped, but feel free to open an issue if you find a bug or have a suggestion.
|
|
|
|
---
|
|
|
|
<div align="center">
|
|
|
|
Made with ☕ and Avalonia UI.
|
|
|
|
</div> |