Thanks to visit codestin.com
Credit goes to github.com

Skip to content
/ zen Public
forked from sheshbabu/zen

Selfhosted notes app. Single golang binary, notes stored as markdown within SQLite, full-text search, very low resource usage

License

Notifications You must be signed in to change notification settings

iamlos/zen

 
 

Repository files navigation

Zen

Minimal Notes App

Features

  • Single Go binary or Docker Compose
  • Low resource usage
  • Standard Markdown files, local SQLite database
  • Organize with flexible tags, not rigid folders
  • Markdown features like tables, code blocks, task lists, highlights, and more
  • Full-text search with BM25 ranking
  • Minimal dependency footprint

Installation

Build from source

$ go build

Local Development

Run the application using default configuration

$ make dev

Run the application in watch mode

Install air and esbuild

$ go install github.com/air-verse/air@latest
$ go install github.com/evanw/esbuild/cmd/esbuild@latest
$ make watch

Schema Migrations

  • Create new migration file under ./migrations
  • Use the format <version>_<title>.sql

Contributions

This is a personal project built for my own use. The codebase is available for forking and modifications. Note that I may not actively review pull requests or respond to issues due to time constraints.

Thanks

About

Selfhosted notes app. Single golang binary, notes stored as markdown within SQLite, full-text search, very low resource usage

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 43.8%
  • Go 36.1%
  • CSS 18.9%
  • Other 1.2%