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
<DescriptionDefaultValue="Advanced analysis of personal finances (multiple dimensions). Automatically import up to 2 years of bank transactions (via the Lunch Money app)."/>
<bt:Stringid="ShowPaneButton-Tip-Description"DefaultValue="Click to show the ExpLens task pane. Synchronize your Bank Transactions from there."/>
97
-
<bt:Stringid="GetStarted-Description"DefaultValue="Analyze your finances. Synchronize Bank Transactions with Lunch Money. To view: [HOME tab] > [ExpLens] > [Show Pane]."/>
93
+
<bt:Stringid="GetStarted-Description"DefaultValue="Analyze your finances. Import 2+ years of bank transactions. To view: [HOME tab] > [Finances] > [ExpLens]."/>
94
+
<bt:Stringid="ShowPaneButton-Tip-Description"DefaultValue="Click to show the ExpLens task pane. Synchronize your Bank Transactions from there."/>
Copy file name to clipboardExpand all lines: README.md
+78-14Lines changed: 78 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,8 @@ ExpLens Excel-AddIn
6
6
7
7
### Intent
8
8
9
-
This project enables people to work with their financial data freely and effectively, without restrictions. However, to protect the effort invested in building and maintaining it, commercial/competitive use is restricted.
9
+
This project enables people to work with their financial data freely and effectively, without restrictions.
10
+
However, to protect the effort invested in building and maintaining it, commercial/competitive use is restricted.
10
11
11
12
**Interested in commercial use?
12
13
Reach out! We'll work out reasonable terms.**
@@ -24,26 +25,89 @@ See [LICENSE.md](./LICENSE.md) for complete terms.
24
25
- ✗ Building competing commercial products/services: _not allowed_.
25
26
- ✗ Selling or hosting as a service: _not allowed_.
26
27
27
-
_Disclaimer: The authors and contributors accept no responsibility, direct or indirect, for any consequences from using this project._
28
+
_Disclaimer: The authors and contributors accept no responsibility, direct or indirect, for any consequences from
29
+
using this project._
28
30
29
31
## Developer guide
30
32
31
-
(This section is work in progress.)
33
+
(If some info was missing and you needed to figure it out, please create a pull request to add it here.)
32
34
33
35
#### Install
34
36
35
-
```bash
36
-
npm install
37
-
```
37
+
Clone the repo. Then:
38
38
39
-
#### Start the app in development mode (hot-code reloading, error reporting, etc.)
39
+
`npm install` or `npm ci`
40
40
41
-
```bash
42
-
quasar dev
43
-
```
41
+
#### Build and start locally
44
42
45
-
#### Build the app for production
43
+
`npm run dev --qPublicBasePath=app/current/excel`
44
+
(this invokes `quasar dev` and passes a parameter to set the URL base the way Excel expects it)
46
45
47
-
```bash
48
-
quasar build
49
-
```
46
+
Quasar will build the app and host it under `http://localhost:9000/app/current/excel/`.
47
+
Note: if port 9000 is taken, Quasar might silently choose another port. However, Excel will look for ExpLens on
48
+
port 9000. If you need to use another port, make sure to modify the manifest accordingly
49
+
(`ExpLens.Excel-AddIn.Manifest.xml`).
50
+
51
+
##### Build for production
52
+
53
+
`quasar build` or `npm run build --qPublicBasePath=url/base/path`
54
+
55
+
#### Activate the Excel Add-In
56
+
57
+
The _release_ version of ExpLens works on Excel Web and Excel Desktop (Windows & Mac).
58
+
59
+
The instructions here are for the _dev_ version (Windows desktop).
60
+
61
+
##### Option 1: "Admin Style" (easer to uninstall)
62
+
63
+
1. Share the root folder of your cloned repo as a local network drive.
64
+
E.g., if you cloned into `c:\Code\ExpLens\` and your machine is called `DEV-PC`, then your share might be
65
+
called `\\DEV-PC\ExpLens`.
66
+
67
+
2. In Excel, add the network share as a trusted Add-In Catalog:
68
+
- Go to: _File_ > _Options_ > _Trust Center_ > _Trust Center Settings_ > _Trusted Add-In Catalogs_.
69
+
- In _Catalog Url_, enter the address of your file share
70
+
(e.g., `\\DEV-PC\ExpLens`).
71
+
- Click _Add catalog_, select _Show in menu_, OK all dialogs, and restart Excel (make sure to close all windows).
72
+
73
+
3. Activate the Add-In:
74
+
_Home_ > _Add-ins_ > _More Add-ins_. At the top you will have a _Shared Folder_ option. When you select it, you
75
+
will see the ExpLens add-in in the list. Install it.
76
+
77
+
The Add-In will start and attempt to load from
78
+
`http://localhost:9000/app/current/excel/`
79
+
80
+
(See section 'Build and start locally' above.)
81
+
82
+
###### Uninstalling:
83
+
84
+
Return to _Trusted Add-In Catalogs_, remove the shared repo directory, conform, and restart Excel (all windows).
85
+
86
+
##### Option 2: "Dev Style" (easer to get started)
87
+
88
+
1. Clone the repo and install packages.
89
+
(see above)
90
+
91
+
2. Build and start the dev server.
92
+
(see above)
93
+
94
+
3. Install the manifest using the Office AddIn tool:
95
+
`npm run office-start`
96
+
This will put some settings into the registry and open Excel with the Add-In loaded.
97
+
98
+
The Add-In will start and attempt to load from
99
+
`http://localhost:9000/app/current/excel/`
100
+
101
+
(See section 'Build and start locally' above.)
102
+
103
+
###### Uninstalling:
104
+
105
+
If you thought this was easier than the "Admin Style", then you have not yet tried to uninstall the
106
+
Add-In (which is a normal par of the dev process).
107
+
If you time it well, then this will do it:
108
+
`npm run office-stop`
109
+
110
+
But some of the time the state required for the tool to correctly know how to uninstall is lost, and you have to
0 commit comments