{"id":15757893,"url":"https://github.com/12joan/untitled-note","last_synced_at":"2025-03-13T17:34:33.003Z","repository":{"id":243492198,"uuid":"391990232","full_name":"12joan/untitled-note","owner":"12joan","description":"An open-source app for taking notes that feels awesome to use","archived":false,"fork":false,"pushed_at":"2025-03-07T16:19:27.000Z","size":16981,"stargazers_count":6,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-07T17:27:49.574Z","etag":null,"topics":["note-taking","rich-text-editor","self-hostable"],"latest_commit_sha":null,"homepage":"https://untitlednote.xyz/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/12joan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"12joan"}},"created_at":"2021-08-02T14:55:32.000Z","updated_at":"2025-03-07T16:19:30.000Z","dependencies_parsed_at":"2024-08-24T02:27:55.736Z","dependency_job_id":"ed03f10d-6318-4b1c-9ebb-6bece32fd371","html_url":"https://github.com/12joan/untitled-note","commit_stats":{"total_commits":1093,"total_committers":4,"mean_commits":273.25,"dds":0.5562671546203111,"last_synced_commit":"49c4715c1ba10df74aa0b3eee13eb0eb78e6f73c"},"previous_names":["12joan/untitled-note"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/12joan%2Funtitled-note","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/12joan%2Funtitled-note/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/12joan%2Funtitled-note/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/12joan%2Funtitled-note/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/12joan","download_url":"https://codeload.github.com/12joan/untitled-note/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243448353,"owners_count":20292594,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["note-taking","rich-text-editor","self-hostable"],"created_at":"2024-10-04T09:40:43.699Z","updated_at":"2025-03-13T17:34:30.922Z","avatar_url":"https://github.com/12joan.png","language":"TypeScript","funding_links":["https://github.com/sponsors/12joan"],"categories":[],"sub_categories":[],"readme":"# Untitled Note App\n\nAn open-source app for taking notes that feels awesome to use\n\n![Demo video](app/assets/videos/demo.mp4)\n\n## Self-hosting guide\n\nFollow these instructions to run your own instance using Docker.\n\n**[Self-hosting guide](https://untitlednote.xyz/docs/self-hosting)**\n\n## Development\n\nTo run the app:\n\n1. Install Docker\n2. Copy `.env.example` to `.env` and configure the environment variables\n3. `yarn install`\n4. `docker compose up` (`--build` may be required if dependencies have been modified)\n5. `docker compose exec web yarn build`\n6. Go to http://localhost:3000/\n7. Create an account with email address `user@example.com`\n8. (If SMTP is disabled) Confirm your email address at http://localhost:3000/email_previews?to=user%40example.com\n\nTo convert your user to an admin:\n\n```\n$ docker compose exec web rails c\nirb(main):001:0\u003e User.find_by(email: 'user@example.com).update(admin: true)\n```\n\nTo run the tests:\n\n```bash\n# Backend tests\ndocker compose web rails test\n\n# Frontend tests\nyarn test\n\n# Fix linter errors\nyarn lint --fix\n\n# Watch for TypeScript errors\nyarn typecheck:watch\n\n# Run Playwright tests\nyarn playwright install # First time only\nyarn e2e\n\n# Debug a Playwright test\nyarn e2e client/e2e/some-test.spec.ts:LINE_NUMBER --debug\nyarn e2e client/e2e/some-test.spec.ts:LINE_NUMBER --debug --project chromium\n```\n\n## Contributing\n\nPlease open a discussion before starting work on a feature you intend to contribute back to this repo. Keep the following guidelines in mind:\n\n- We try to keep the app very minimal, so not all features will be a good fit for inclusion.  \n- All features must be usable with the keyboard, using a screen reader, and on a mobile device.\n- Features involving generative machine learning models will not be considered.\n\nBug-fixing PRs are always welcome.\n\n## Security\n\nIf you discover a security issue with the app, please contact me directly. All security research should be performed on a private instance.\n\n## Enterprise support\n\nWant help customising Untitled Note App for use in your organisation? Contact me to discuss a consultancy agreement.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F12joan%2Funtitled-note","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F12joan%2Funtitled-note","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F12joan%2Funtitled-note/lists"}