A simple journaling app built in Go.
static | ||
templates | ||
.gitignore | ||
go.mod | ||
go.sum | ||
main.go | ||
Makefile | ||
README.md |
Journey ✨
jny
short for Journey is a simple Journaling-webapp that can be deployed as a single binary. Journal entries are stored in theentries/
subdirectory as simple markdown files.
Features 📦
- Write your Journal entries from a Web-UI, accessible from everywhere
- List all your entries
- Navigate back and forth from a current entry
- Get your data in an independent Markdown format
- Simple single binary deployment
- Secure it via Basic Auth (Optional)
Building 🔨
As simple as go build -o dist/jny main.go
. You can also use the Makefile
to build for all platforms at once via make build
.
Usage ⚙️
Usage of jny:
-dir string
directory to store the journal files (default "entries")
-port int
port to bind to (default 1337)
-username string
Username for basic auth
-password string
Password for basic auth
If you would like to protect your journaling with basic auth, pass the -username
and the -password
flag when running journey. If no credentials are provided, the app is publicly accessible.
Dependencies & Building Blocks ⚒️
gomarkdown
- Markdown to HTML conversionEeasyMDE
- Web Markdown editorsimple.css
- Simple and basic CSS styling