8000 GitHub - biozz/notebase: Yet another take on the "Everything App" based on markdown notes
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
/ notebase Public

Yet another take on the "Everything App" based on markdown notes

Notifications You must be signed in to change notification settings

biozz/notebase

Repository files navigation

notebase

Notebase is my yet another iteration on the "Everything App". This time I am going for my markdown notes.

There are several key points, why I develop this project:

  • I need a mobile-friendly web interface for my notes (Obsidian Web is not good enough, and Obsidian App is too heavy)
  • I want a well-established query language, like SQL to work with my notes (Dataview and Datacore are still great, but see previous point)
  • I want to replace multiple tools I use for everyday life and I always thought they fit nicely into my markdown notes, just need a better interface (like todo lists, finance goals, tv show tracker, habit tracker, etc.)

I document some of my decisions regarding this project in docs/adrs.

Development

You are going to need Go (whichever version is provided in go.mod) and Node/pnpm.

There is an example/ directory with a bunch of notes and a config file.

go run . --root=./example/notes serve

If you feel ambitious after thoroughly inspecting the source code, you can do go run . --root=/abs/path/to/your/vault serve and try it on the real data. :)

And if you do, don't forget to add .notebase.yml to your root. You can check out my current config in /examples/biozz_notebase_config.yml.

serve command also starts a background sync job. serve will created pb_data directory, which should not be checked into the VCS and is meant to be disposable. That means taht if there is any error or migration conflict you delete pb_data and run the server again.

Follow PocketBase instructions to create an account.

Then you can run frontend separately (assuming you installed dependencies):

pnpm dev

Contributing

I might be interested in some contributions, but because it is an experimental project, I would prefer discussions and maybe code-reviews of the non-optimal or non-conventional parts of the codebase.

About

Yet another take on the "Everything App" based on markdown notes

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0