Initial commit

2024-06-19 11:17:46 -05:00
commit 1e25a806d9
5 changed files with 1355 additions and 0 deletions
@@ -0,0 +1,31 @@
+# Actual Budget Helper Scripts
+
+This is a collection of useful scripts to help you manage your Actual Budget.
+
+## Requirements
+
+- [Actual Budget](https://actualbudget.org/)
+- [Node.js](https://nodejs.org/) (21.6.2+)
+    - [@actual-app/api](https://www.npmjs.com/package/@actual-app/api)
+    - [dotenv](https://www.npmjs.com/package/dotenv)
+    - [jsdom](https://www.npmjs.com/package/jsdom)
+
+## Configuration
+
+Create a `.env` file in the root directory with the following content:
+
+```python
+ACTUAL_SERVER_URL="https://<Actual Budget server URL>"
+ACTUAL_SERVER_PASSWORD="<Actual Budget server password>"
+ACTUAL_SYNC_ID="<Actual Budget sync ID>"
+
+# optional, for encrypted files
+ACTUAL_FILE_PASSWORD="<file password>"
+
+# optional, if you want to use a different cache directory
+ACTUAL_CACHE_DIR="./cache"
+```
+
+## Installation
+
+Run `npm install` to install any required dependencies.