You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-21Lines changed: 8 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,9 @@
22
22
23
23
# Why Create This?
24
24
25
-
There are a ton of amazing projects for expense tracking across GitHub ([Actual](https://github.com/actualbudget/actual), [Firefly III](https://github.com/firefly-iii/firefly-iii), etc.). They're all incredible, but they aren't the *fastest* when trying to add expenses and offer many features I don't use. Some use varying formats of data or complex APIs. *Don't get me wrong*, they're great when needed, but I wanted something dead simple that only gives me a monthly pie chart and a tabular representation. NOTHING else!
25
+
There are a ton of amazing projects for expense tracking across GitHub ([Actual](https://github.com/actualbudget/actual), [Firefly III](https://github.com/firefly-iii/firefly-iii), etc.). They're all incredible, but they aren't the *fastest* when trying to add expenses and offer many features I don't use. Some use varying formats of data or complex budgeting or complex APIs. *Don't get me wrong*, they're incredible when fully utilized, but I wanted something dead simple that only gives me a monthly pie chart and a tabular representation. NOTHING else!
26
26
27
-
Hence, I created this project, which I use in my home lab to track my expenses. The data is just JSON, so I can do whatever I want with it, including using `jq` to convert to CSV. The UI is elegant and mobile-friendly.
28
-
29
-
This app's intention is to track spending across your categories in a simplistic manner. There is no complicated searching or editing - just add, delete, and view! This intention will not change throughout the project's lifecycle. This is not an app for budgeting; it's for tracking.
27
+
So, I created this project, which I use in my home lab to track my expenses. This app's intention is to track spending across your categories (custom or pre-defined) in a simplistic manner. There is no complicated searching or editing - just `add`, `delete`, and `view`! This intention will not change throughout the project's lifecycle. This is *not* an app for budgeting; it's for straightforward tracking.
30
28
31
29
# Features
32
30
@@ -39,7 +37,6 @@ This app's intention is to track spending across your categories in a simplistic
39
37
- REST API for expense management
40
38
- Single-user focused (mainly for a home lab deployment)
41
39
- CSV export of all expense data from the UI
42
-
- CLI for both server and client (if needed) operations
43
40
- Custom categories via environment variable (`EXPENSE_CATEGORIES`) with sensible defaults
44
41
- Custom currency symbol in the frontend via environment variable (`CURRENCY`)
45
42
@@ -68,9 +65,9 @@ I reiterate that you should use this to add expenses quickly. The default name f
68
65
69
66
In the ideal case, `enter the amount and choose the category` - that's it!
70
67
71
-
For a bit more involved case, `enter the amount and name, choose the category, and select the date` - still very simple!
68
+
For a bit more involved case, `enter the name, choose the category, enter the amount, and select the date` - still very simple!
72
69
73
-
The application only allows addition and deletion; there's no need for editing. There are no tags, wallet info, budgeting, or anything else! Plain and simple for the win.
70
+
The application only allows addition and deletion; there's no need for editing (if needed, just delete and re-add). There are no tags, wallet info, budgeting, or anything else! Plain and simple for the win.
74
71
75
72
# Screenshots
76
73
@@ -148,30 +145,20 @@ Ideally, once deployed, use the web interface and you're good to go. Access the
148
145
149
146
If command-line automations are required for use with the REST API, read on!
150
147
151
-
### CLI Mode
152
-
153
-
The application binary can run in either server or client mode:
148
+
### Executable
154
149
155
-
Server Mode (Default):
150
+
The application binary can be run directly within CLI for any common OS and architecture:
156
151
157
152
```bash
158
153
./expenseowl
159
-
# or explicitly
160
-
./expenseowl -serve
161
154
# or from a custom directory
162
155
./expenseowl -data /custom/path
163
156
```
164
157
165
-
Client Mode:
166
-
167
-
```bash
168
-
./expenseowl -client -addr localhost:8080
169
-
```
170
-
171
-
In client mode, you'll be prompted to enter the expense name, category (select from a list), amount, and date (in YYYY-MM-DD; optional, sets to the current date when not provided).
172
-
173
158
### REST API
174
159
160
+
ExpenseOwl provides an API to allow adding expenses via automations or simply via cURL, Siri Shortcuts, or other automations.
0 commit comments