notes

A simple note-taking web app.

Tech stack

Rails with Hotwire, Stimulus, Importmaps, Tailwind, and SQLite.

Getting started

# clone the repo
git clone https://github.com/jethrodaniel/notes
cd notes

# setup the app
bundle
bin/setup

# run it locally
bin/dev

Then visit http://localhost:3000 in your browser.

You can sign in with the default credentials (see db/seeds.rb for details):

email: [email protected]
password: password

Testing

bin/ci

You may also need to install dependencies for system tests:

snap install chromium # e.g, on ubuntu 24.04

Deployment

You can deploy with kamal like so:

• provision a server
• vendor your own basecamp/kamal-proxy:v0.8.7 image
• cp .env.example .env, and fill out your information
• first time: bin/deploy_setup
  • TODO: fix/clean up this setup step (might not work on a new server atm)
• subsequent deploys: bin/deploy

To vendor your own kamal-proxy:

docker pull basecamp/kamal-proxy:v0.8.4
docker login <REGISTRY> # e.g, `registry.gitlab.com`
docker tag basecamp/kamal-proxy:v0.8.4 <REGISTRY>/<USER>/kamal-proxy:v0.8.4
docker push <REGISTRY>/<USER>/kamal-proxy:v0.8.4

License

Notes is released under the GNU Affero General Public License Version 3 (AGPLv3) or any later version.

Copyright 2025 Mark Delk. All rights reserved.

Contributing

While the code is released under the AGPL, I'd still like to be able to release it under something like the MIT license eventually.

To that end, contributions aren't accepted (yet).