README.md

private-notes

If this application gets off the ground, it will support groups having long form private conversations using E2E encryption with keys stored by the consuming clients.

Development instructions

1. Install Go 1.22
2. Install PostgreSQL 13.1
3. ./scripts/setup_dev_dbs to create development database
4. Run cp .env.example .env
5. Update .env for login (needs google creds + session keys)
6. If you want emails to work, you can create an app password and use that in the .env.
7. Run go run main.go

Generate Session Keys

• use gore https://github.com/motemen/gore (OR) golang playground https://play.golang.org to generate keys
• use golang crypto/rand.Read https://golang.org/pkg/crypto/rand/
• (OR) securecookie.GenerateRandomKey() https://godoc.org/github.com/gorilla/securecookie
• fmt.Printf("SESSION_AUTH_KEY=%x \n", securecookie.GenerateRandomKey(64)) fmt.Printf("SESSION_ENCRYPTION_KEY=%x \n", securecookie.GenerateRandomKey(32))

Roadmap + TODOs

• Migrate all unnecessary util code to github.com/xy-planning-network/trails
• Move http to root directory + tmpl into http
• Implement better redirect handling with flash messages
• Add notifications for creating a note + creating a comment (plaintext email using basic auth)
• Fix bug with trix not rendering content
• Setup Procfile + run on heroku
• Setup DNS on domain + add users to database for login
• Update to latest version of tailwindcss
• Add environment + embed in necessary structs
• Add logging and update email failure (create note + create comment)
• Add guide for running the app for dev
• Render flash with alpinejs
• Paginate lists (notes)
• Add MVP of meetings
• Fix wonky spacing in comments (either newlines aren't captured or not being rendered)
• Add better sigterm handling
• Spike out code for HTMX based implementation
• Spike out SSE implementation for meeting + goals
• Remove hotwire for HMTX dep
• Add MVP of meeting review
• Adds templ POC to /templ
• Update header to context based breadcrumb
• Paginate meetings
• Implement application encryption for note content (E2E)
• Add draft feature for notes
• Add edit ability to group
• Add testing
• Improve rendering of partials (remove need for wrapper) and move to trails

Build for fly.io deploy

GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build