Skip to content

Commit

Permalink
updates gems and locks versions
Browse files Browse the repository at this point in the history
  • Loading branch information
simonneutert committed Feb 16, 2025
1 parent c317718 commit 780f0fb
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 39 deletions.
2 changes: 1 addition & 1 deletion .tool-versions
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
ruby 3.4.1
ruby 3.3.7
rust 1.76.0
nodejs 22.8.0
25 changes: 20 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,22 @@ new entry format:

- [PR#](url) Description. - [@user](url)

### v0.5.7 (2025/02/16)

- [#166](https://github.com/simonneutert/labradorite-notebook/pull/132)
Dependencies and version locks. -
[@simonneutert](https://github.com/simonneutert)

### v0.5.0 (2024/09/01)

- [#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)
- [#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)
- [#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)
- [#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)

### 0.4.4 (2023/11/17)

Expand Down Expand Up @@ -54,7 +66,8 @@ new entry format:

- sets utf-8 docker locales
- uppy setup to non-js-module, but script source
- upload filename utf-8 force encoding, replaces unknown character with underscore
- upload filename utf-8 force encoding, replaces unknown character with
underscore

### 0.1.6 (2022/12/27)

Expand All @@ -74,11 +87,13 @@ new entry format:

### 0.1.2 (2022/10/29)

- highlights search text in search results with yellow marker 🖍 - [@simonneutert](https://github.com/simonneutert).
- highlights search text in search results with yellow marker 🖍 -
[@simonneutert](https://github.com/simonneutert).

### 0.1.1 (2022/10/22)

- drops shipping of default memos, allowing easier upgrades - [@simonneutert](https://github.com/simonneutert).
- drops shipping of default memos, allowing easier upgrades -
[@simonneutert](https://github.com/simonneutert).

### 0.1.0 (2022/10/22)

Expand Down
2 changes: 2 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ RUN bundle install -j${bundler_jobs}

FROM ruby:3.3-alpine

RUN apk update && apk upgrade

RUN apk add nodejs npm \
&& rm -rf /var/cache/apk/*; \
npm install -g prettier;
Expand Down
17 changes: 9 additions & 8 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ GEM
specs:
ast (2.4.2)
coderay (1.1.3)
concurrent-ruby (1.3.4)
diff-lcs (1.5.1)
concurrent-ruby (1.3.5)
diff-lcs (1.6.0)
fiddle (1.1.6)
hashie (5.0.0)
htmlbeautifier (1.4.3)
Expand Down Expand Up @@ -45,10 +45,10 @@ GEM
regexp_parser (2.10.0)
reline (0.6.0)
io-console (~> 0.5)
rexml (3.4.0)
rexml (3.4.1)
roda (3.89.0)
rack
rubocop (1.72.0)
rubocop (1.72.1)
json (~> 2.3)
language_server-protocol (~> 3.17.0.2)
lint_roller (~> 1.1.0)
Expand All @@ -64,17 +64,18 @@ GEM
rubocop-minitest (0.36.0)
rubocop (>= 1.61, < 2.0)
rubocop-ast (>= 1.31.1, < 2.0)
rubocop-performance (1.23.1)
rubocop (>= 1.48.1, < 2.0)
rubocop-ast (>= 1.31.1, < 2.0)
rubocop-performance (1.24.0)
lint_roller (~> 1.1)
rubocop (>= 1.72.1, < 2.0)
rubocop-ast (>= 1.38.0, < 2.0)
rubocop-rake (0.6.0)
rubocop (~> 1.0)
ruby-next (0.14.1)
ruby-next-core (= 0.14.1)
ruby-next-parser (>= 3.1.1.0)
unparser (~> 0.6.0)
ruby-next-core (0.14.1)
ruby-next-parser (3.2.2.0)
ruby-next-parser (3.4.0.2)
parser (>= 3.0.3.1)
ruby-progressbar (1.13.0)
rutie (0.0.4)
Expand Down
72 changes: 47 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

<img align="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">

> 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.
> 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.
>
> _\- every esoteric out there_
Expand All @@ -12,13 +14,16 @@

---

> [!IMPORTANT]
> [Tantiny](https://github.com/baygeldin/tantiny) has died this summer (most probably) ...
> [!IMPORTANT] [Tantiny](https://github.com/baygeldin/tantiny) has died this
> summer (most probably) ...
>
> This project heavily depends on Tantiny, and as a result, we anticipate releasing our final updates in the near future.
> 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. 😔
> 🥲 It will continue to work though! As it is fulfilling what it was built for in the first place.
> Dependabot will help keep security vulnerabilities closed and containerization will do the rest.
> This project heavily depends on Tantiny, and as a result, we anticipate
> releasing our final updates in the near future.\
> 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. 😔 🥲 It will continue to work though! As it is
> fulfilling what it was built for in the first place. Dependabot will help keep
> security vulnerabilities closed and containerization will do the rest.
---

Expand All @@ -40,21 +45,27 @@

## Rationale

Most Notetaking apps do either too much (Notion), too little (Apple Notes) and lock me in (all options ever).
Most Notetaking apps do either too much (Notion), too little (Apple Notes) and
lock me in (all options ever).

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:
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:

- **ownership** of the notes (flat files)
- **ownership** of the notes (flat files)\
markdown, yaml, attachments all in one place in directories
- **easy** on the eyes/mind
- **easy** on the eyes/mind\
I don't want to see all the old stuff I may not need anymore
- a search that shows me **snips** in the notes
- a search that shows me **snips** in the notes\
not just the notes in a sidebar
- a very simple **tagging** support
- basic **file uploads**
- basic **file uploads**\
keeping the originals side by side with notes

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.
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.

---

Expand Down Expand Up @@ -95,7 +106,8 @@ I like to keep things simple, so I once again fell for [Roda](https://roda.jerem
## Technical Prerequisites

- Ruby v3.x are tested and ready to roll
- Install a stable version of [Rust](https://www.rust-lang.org/) with [Cargo](https://github.com/rust-lang/cargo)
- Install [[email protected]](https://www.rust-lang.org/) with
[Cargo](https://github.com/rust-lang/cargo)

## Architecture

Expand All @@ -111,7 +123,8 @@ Little experiment on how it rolls:
- `views`: ERB Views
- `memos`: the Memos/Notes in subdirectories `YYYY/MM/DD/random-string`
- `public`: css/js/media
- `.tantiny`: the local index data created by the [tantiny](https://github.com/baygeldin/tantiny) gem
- `.tantiny`: the local index data created by the
[tantiny](https://github.com/baygeldin/tantiny) gem

## Major Dependencies

Expand All @@ -121,7 +134,8 @@ Little experiment on how it rolls:

## Run/Deploy with Docker

The included `Dockerfile` and the `docker-compose.yml` are more a stub to build upon.
The included `Dockerfile` and the `docker-compose.yml` are more a stub to build
upon.

Currently the Dockerfile support passing the USERNAME as an `build-arg`.

Expand All @@ -130,34 +144,42 @@ Currently the Dockerfile support passing the USERNAME as an `build-arg`.

Either this way, or you adapt the Dockerfile to your needs.

Let's say your username on the server you run (or your machine) is `johndoe`, then your Dockerfile should look something like this:
Let's say your username on the server you run (or your machine) is `johndoe`,
then your Dockerfile should look something like this:

```Dockerfile
# in your version of the Dockerfile, replace labradorite at the ARG USERNAME
ARG USERNAME=johndoe
```

That will help you both secure the service and have the files being created with the proper rights on the host system.
That will help you both secure the service and have the files being created with
the proper rights on the host system.

### Docker Compose

build and/or up using: `$ USERNAME=$(whoami) docker-compose build`

**Volumes**

- 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 😉)
- fyi: having tantiny's index (`.tantiny`) as a volume has no benefit. Beware, it can easily have a negative impact.
- 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 😉)
- fyi: having tantiny's index (`.tantiny`) as a volume has no benefit. Beware,
it can easily have a negative impact.

## Development

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.
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.

- `$ rake test` runs the test suite
- `$ rake reset_default_memos` resets the files to the repos defaults (e.g. for testing)
- `$ rake reset_default_memos` resets the files to the repos defaults (e.g. for
testing)
- `$ rake reset_memos` clears ALL memos

Before pushing code, you should always run `rake reset` and `rake test`,
**therefore have a repo you work on AND another you use JUST for running the software.**
Before pushing code, you should always run `rake reset` and `rake test`,\
**therefore have a repo you work on AND another you use JUST for running the
software.**

## Run it

Expand Down

0 comments on commit 780f0fb

Please sign in to comment.