Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/12joan/untitled-note
An open-source app for taking notes that feels awesome to use
https://github.com/12joan/untitled-note
note-taking rich-text-editor self-hostable
Last synced: 2 months ago
JSON representation
An open-source app for taking notes that feels awesome to use
- Host: GitHub
- URL: https://github.com/12joan/untitled-note
- Owner: 12joan
- License: mit
- Created: 2021-08-02T14:55:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T00:16:53.000Z (2 months ago)
- Last Synced: 2024-10-25T04:51:55.964Z (2 months ago)
- Topics: note-taking, rich-text-editor, self-hostable
- Language: TypeScript
- Homepage: https://untitlednote.xyz/
- Size: 15.6 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Untitled Note App
An open-source app for taking notes that feels awesome to use
## Self-hosting guide
Follow these instructions to run your own instance using Docker.
**[Self-hosting guide](https://untitlednote.xyz/docs/self-hosting)**
## Development
To run the app:
1. Install Docker
2. Copy `.env.example` to `.env` and configure the environment variables
3. `yarn install`
4. `docker compose up` (`--build` may be required if dependencies have been modified)
5. `docker compose exec web yarn build`
6. Go to http://localhost:3000/
7. Create an account with email address `[email protected]`
8. (If SMTP is disabled) Confirm your email address at http://localhost:3000/email_previews?to=user%40example.com
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:
```bash
# 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
```
## Contributing
Please open a discussion before starting work on a feature you intend to contribute back to this repo. Keep the following guidelines in mind:
- We try to keep the app very minimal, so not all features will be a good fit for inclusion.
- All features must be usable with the keyboard, using a screen reader, and on a mobile device.
- Features involving generative machine learning models will not be considered.
Bug-fixing PRs are always welcome.
## Security
If you discover a security issue with the app, please contact me directly. All security research should be performed on a private instance.
## Enterprise support
Want help customising Untitled Note App for use in your organisation? Contact me to discuss a consultancy agreement.