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
-[#132](https://github.com/simonneutert/labradorite-notebook/pull/132) All new posts' title will be set to the current date. Please visit the [UPGRADING](UPGRADING.md) readme file, too. - [@simonneutert](https://github.com/simonneutert)
22
-
-[#106](https://github.com/simonneutert/labradorite-notebook/pull/106) Updates Ruby, Node.js, and Nokogiri versions, and replace unmaintained tag JS framework with "use-bootstrap-tag". - [@simonneutert](https://github.com/simonneutert)
27
+
-[#132](https://github.com/simonneutert/labradorite-notebook/pull/132) All new
28
+
posts' title will be set to the current date. Please visit the
Copy file name to clipboardExpand all lines: README.md
+47-25
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,9 @@
2
2
3
3
<imgalign="right"src="https://github.com/simonneutert/labradorite-notebook/blob/main/public/labradorite.jpg?raw=true"alt="Labradorite dreamed by openai's Dall-E2: A brown labrador shooting a lazer from a blue crystal on its forehead, digital art">
4
4
5
-
> Labradorite rightfully belongs to the group of wisdom crystals, because it promotes a free flow of mental energy as it awakens intuition and allows us to get mentally unstuck.
5
+
> Labradorite rightfully belongs to the group of wisdom crystals, because it
6
+
> promotes a free flow of mental energy as it awakens intuition and allows us to
7
+
> get mentally unstuck.
6
8
>
7
9
> _\- every esoteric out there_
8
10
@@ -12,13 +14,16 @@
12
14
13
15
---
14
16
15
-
> [!IMPORTANT]
16
-
> [Tantiny](https://github.com/baygeldin/tantiny) has died this summer (most probably) ...
17
+
> [!IMPORTANT][Tantiny](https://github.com/baygeldin/tantiny) has died this
18
+
> summer (most probably) ...
17
19
>
18
-
> This project heavily depends on Tantiny, and as a result, we anticipate releasing our final updates in the near future.
19
-
> I am committed to maintaining the project's functionality for as long as feasible. However, I will not be investing additional time or resources into its further development. 😔
20
-
> 🥲 It will continue to work though! As it is fulfilling what it was built for in the first place.
21
-
> Dependabot will help keep security vulnerabilities closed and containerization will do the rest.
20
+
> This project heavily depends on Tantiny, and as a result, we anticipate
21
+
> releasing our final updates in the near future.\
22
+
> I am committed to maintaining the project's functionality for as long as
23
+
> feasible. However, I will not be investing additional time or resources into
24
+
> its further development. 😔 🥲 It will continue to work though! As it is
25
+
> fulfilling what it was built for in the first place. Dependabot will help keep
26
+
> security vulnerabilities closed and containerization will do the rest.
22
27
23
28
---
24
29
@@ -40,21 +45,27 @@
40
45
41
46
## Rationale
42
47
43
-
Most Notetaking apps do either too much (Notion), too little (Apple Notes) and lock me in (all options ever).
48
+
Most Notetaking apps do either too much (Notion), too little (Apple Notes) and
49
+
lock me in (all options ever).
44
50
45
-
I wanted something that does **just-enough**™, in the spirit of a _flat file cms_. Let me try and wrap it up in a few bullets:
51
+
I wanted something that does **just-enough**™, in the spirit of a _flat file
52
+
cms_. Let me try and wrap it up in a few bullets:
46
53
47
-
-**ownership** of the notes (flat files)
54
+
-**ownership** of the notes (flat files)\
48
55
markdown, yaml, attachments all in one place in directories
49
-
-**easy** on the eyes/mind
56
+
-**easy** on the eyes/mind\
50
57
I don't want to see all the old stuff I may not need anymore
51
-
- a search that shows me **snips** in the notes
58
+
- a search that shows me **snips** in the notes\
52
59
not just the notes in a sidebar
53
60
- a very simple **tagging** support
54
-
- basic **file uploads**
61
+
- basic **file uploads**\
55
62
keeping the originals side by side with notes
56
63
57
-
I like to keep things simple, so I once again fell for [Roda](https://roda.jeremyevans.net) as the Web Layer. [Tantiny](https://github.com/baygeldin/tantiny) is the kicker for this project. I was curious, if I could come up with something useful quickly, not having to deal with a complicated setup or Postgres as a requirement.
64
+
I like to keep things simple, so I once again fell for
65
+
[Roda](https://roda.jeremyevans.net) as the Web Layer.
66
+
[Tantiny](https://github.com/baygeldin/tantiny) is the kicker for this project.
67
+
I was curious, if I could come up with something useful quickly, not having to
68
+
deal with a complicated setup or Postgres as a requirement.
58
69
59
70
---
60
71
@@ -95,7 +106,8 @@ I like to keep things simple, so I once again fell for [Roda](https://roda.jerem
95
106
## Technical Prerequisites
96
107
97
108
- Ruby v3.x are tested and ready to roll
98
-
- Install a stable version of [Rust](https://www.rust-lang.org/) with [Cargo](https://github.com/rust-lang/cargo)
@@ -121,7 +134,8 @@ Little experiment on how it rolls:
121
134
122
135
## Run/Deploy with Docker
123
136
124
-
The included `Dockerfile` and the `docker-compose.yml` are more a stub to build upon.
137
+
The included `Dockerfile` and the `docker-compose.yml` are more a stub to build
138
+
upon.
125
139
126
140
Currently the Dockerfile support passing the USERNAME as an `build-arg`.
127
141
@@ -130,34 +144,42 @@ Currently the Dockerfile support passing the USERNAME as an `build-arg`.
130
144
131
145
Either this way, or you adapt the Dockerfile to your needs.
132
146
133
-
Let's say your username on the server you run (or your machine) is `johndoe`, then your Dockerfile should look something like this:
147
+
Let's say your username on the server you run (or your machine) is `johndoe`,
148
+
then your Dockerfile should look something like this:
134
149
135
150
```Dockerfile
136
151
# in your version of the Dockerfile, replace labradorite at the ARG USERNAME
137
152
ARG USERNAME=johndoe
138
153
```
139
154
140
-
That will help you both secure the service and have the files being created with the proper rights on the host system.
155
+
That will help you both secure the service and have the files being created with
156
+
the proper rights on the host system.
141
157
142
158
### Docker Compose
143
159
144
160
build and/or up using: `$ USERNAME=$(whoami) docker-compose build`
145
161
146
162
**Volumes**
147
163
148
-
- this `memos` directory has all your created content in it. Having it mounted from your host should make easy for you to backup (if you don't use a private gitrepo for that 😉)
149
-
- fyi: having tantiny's index (`.tantiny`) as a volume has no benefit. Beware, it can easily have a negative impact.
164
+
- this `memos` directory has all your created content in it. Having it mounted
165
+
from your host should make easy for you to backup (if you don't use a private
166
+
gitrepo for that 😉)
167
+
- fyi: having tantiny's index (`.tantiny`) as a volume has no benefit. Beware,
168
+
it can easily have a negative impact.
150
169
151
170
## Development
152
171
153
-
From v0.5.0 on, the project can only be run native on a Linux machine or in a Docker container. See the Dockerfiles and `justfile` for more information.
172
+
From v0.5.0 on, the project can only be run native on a Linux machine or in a
173
+
Docker container. See the Dockerfiles and `justfile` for more information.
154
174
155
175
-`$ rake test` runs the test suite
156
-
-`$ rake reset_default_memos` resets the files to the repos defaults (e.g. for testing)
176
+
-`$ rake reset_default_memos` resets the files to the repos defaults (e.g. for
177
+
testing)
157
178
-`$ rake reset_memos` clears ALL memos
158
179
159
-
Before pushing code, you should always run `rake reset` and `rake test`,
160
-
**therefore have a repo you work on AND another you use JUST for running the software.**
180
+
Before pushing code, you should always run `rake reset` and `rake test`,\
181
+
**therefore have a repo you work on AND another you use JUST for running the
0 commit comments