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
+15-35Lines changed: 15 additions & 35 deletions
Original file line number
Diff line number
Diff line change
@@ -18,14 +18,14 @@
18
18
19
19
### Features
20
20
21
-
-🥳 Simple login via google.
22
-
-🌚 Dark and light theme.
23
-
- 💻 Installable (PWA).
24
-
-⬆️ Import your data from Google sheet's annual planner.
25
-
-⬇️ Export your data as a single `.json`-file.
26
-
-🕰 Track budgets across year.
21
+
-🦾 Self-hosted.
22
+
-🕶️ Dark and light theme.
23
+
- 💻 Installable as a PWA.
24
+
-🔼 Import your data from Google sheet's annual planner.
25
+
-🛠️ Export your data as a single `.json`-file.
26
+
-🎇 Track budgets across multiple years.
27
27
- 🙈 Privacy mode for when you're in a public place.
28
-
-🪩 Simple and straight-forward UI.
28
+
-⚡️ Simple and straight-forward UI.
29
29
30
30
> Check out the [demo](https://ocular.reinisch.io#demo)!
31
31
@@ -34,12 +34,8 @@
34
34
A small budgeting app as an alternative to Google sheet's annual budget planner.
35
35
The goal of the app is **not** to track individual expenses, work with multiple currencies at a time or anything related (if you're looking for something like this, check out [firefly-iii](https://www.firefly-iii.org/)).
36
36
37
-
This app comes without any backend and all your data is stored in your google-drive account as an app (no worry - you can always export your data in the app).
38
-
**This app does not have access to anything else except its own files**.
39
-
The (latest) version I use is automatically deployed to [ocular.reinisch.io](https://ocular.reinisch.io) - but feel free to [set it up yourself](#development)!
40
-
41
-
> **Attention:** It's currently **not** possibly to sync the app with your personal gmail account due to the google-cloud app not being verified yet.
42
-
> You can still use it and download / upload your data or [deploy it yourself](#development) (which is even cooler!).
37
+
This app comes with its own backend (by using [genesis](https://github.com/simonwep/genesis)), so the only thing you need to do is to host it somewhere.
38
+
Your data stays on your server and is not shared with anyone else.
43
39
44
40
### State of this project
45
41
@@ -55,30 +51,14 @@ Because of its simplicity the master branch is considered stable and any new fea
55
51
56
52
#### Development
57
53
58
-
This app requires [NodeJS LTS](https://nodejs.org/en/) and uses [vite](https://vitejs.dev/) as builder.
59
-
You can build and preview the app using the following commands:
60
-
61
-
```sh
62
-
npm run build
63
-
npm run preview
64
-
```
54
+
This app uses [genesis](https://github.com/simonwep/genesis) as generic backend.
55
+
Go to the [genesis](https://github.com/simonwep/genesis) repository and follow the instructions to set it up first.
65
56
66
-
To work on it simply run `npm run dev`.
57
+
To run the frontend make sure you have the latest [NodeJS LTS](https://nodejs.org/en/) installed, as well as [pnpm](https://pnpm.io/).
58
+
You can then start the frontend by running `pnpm run dev` in the root directory.
67
59
68
60
#### Production
69
61
70
-
To run this app in production and to add cloud connectivity, you'll need a [Google Cloud App](https://console.cloud.google.com) with
71
-
the `drive.appdata` scope.
72
-
73
-
After you've set up your app fill copy the [.env.example](.env.example) to `.env` and fill in your credentials.
74
-
75
-
##### Using docker
76
-
77
-
This project can be built as a docker-image, that serves the app via nginx.
78
-
You can build and run it via:
79
-
80
-
```sh
81
-
docker build -t ocular .&& docker run -p 8080:80 ocular
82
-
```
62
+
This app is deployed using [docker-compose](https://docs.docker.com/compose/).
63
+
See [ocular-docker](https://github.com/simonwep/ocular-docker) for more information.
83
64
84
-
Ocular should then be available under [localhost:8080](http://localhost:8080)
0 commit comments