An open-source app for taking notes that feels awesome to use
MIT License
An open-source app for taking notes that feels awesome to use
Follow these instructions to run your own instance using Docker.
To run the app:
.env.example
to .env
and configure the environment variablesyarn install
docker compose up
(--build
may be required if dependencies have been modified)docker compose exec web yarn build
[email protected]
To convert your user to an admin:
$ docker compose exec web rails c
irb(main):001:0> User.find_by(email: '[email protected]).update(admin: true)
To run the tests:
# Backend tests
docker compose web rails test
# Frontend tests
yarn test
# Fix linter errors
yarn lint --fix
# Watch for TypeScript errors
yarn typecheck:watch
# Run Playwright tests
yarn playwright install # First time only
yarn e2e
# Debug a Playwright test
yarn e2e client/e2e/some-test.spec.ts:LINE_NUMBER --debug
yarn e2e client/e2e/some-test.spec.ts:LINE_NUMBER --debug --project chromium
Please open a discussion before starting work on a feature you intend to contribute back to this repo. Keep the following guidelines in mind:
Bug-fixing PRs are always welcome.
If you discover a security issue with the app, please contact me directly. All security research should be performed on a private instance.
Want help customising Untitled Note App for use in your organisation? Contact me to discuss a consultancy agreement.