{"id":28358873,"url":"https://github.com/siegerts/dossi-ext","last_synced_at":"2025-07-01T06:38:42.932Z","repository":{"id":242962508,"uuid":"642185860","full_name":"siegerts/dossi-ext","owner":"siegerts","description":"dossi browser extension: Your own private GitHub notes on every page","archived":false,"fork":false,"pushed_at":"2024-07-19T13:38:10.000Z","size":732,"stargazers_count":23,"open_issues_count":5,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-04T14:20:47.969Z","etag":null,"topics":["broswer-extension","chrome-api","chrome-extension","firefox-extension","github-management","open-source","plasmo","reactjs","serverless","shadcn-ui","tailwind","tanstack-react-query","zod"],"latest_commit_sha":null,"homepage":"https://dossi.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/siegerts.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2023-05-18T02:29:40.000Z","updated_at":"2025-02-01T19:00:11.000Z","dependencies_parsed_at":"2024-06-25T03:23:06.697Z","dependency_job_id":"d7981600-6718-43af-b5c4-5652bb9b6297","html_url":"https://github.com/siegerts/dossi-ext","commit_stats":null,"previous_names":["siegerts/dossi-ext"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/siegerts/dossi-ext","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siegerts%2Fdossi-ext","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siegerts%2Fdossi-ext/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siegerts%2Fdossi-ext/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siegerts%2Fdossi-ext/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/siegerts","download_url":"https://codeload.github.com/siegerts/dossi-ext/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siegerts%2Fdossi-ext/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261093004,"owners_count":23108572,"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":["broswer-extension","chrome-api","chrome-extension","firefox-extension","github-management","open-source","plasmo","reactjs","serverless","shadcn-ui","tailwind","tanstack-react-query","zod"],"created_at":"2025-05-28T08:36:27.960Z","updated_at":"2025-07-01T06:38:42.918Z","avatar_url":"https://github.com/siegerts.png","language":"TypeScript","readme":"\u003ca href=\"https://dossi.dev\"\u003e\n  \u003cimg alt=\"Your own private GitHub notes on every page\" src=\"https://github.com/siegerts/dossi-app/blob/main/dossi-1280x800.png\"\u003e\n\u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003edossi\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Your own private GitHub notes on every page\n    \u003cbr /\u003e\n    \u003ca href=\"https://dossi.dev\"\u003e\u003cstrong\u003eLearn more »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n     \u003ca href=\"https://chromewebstore.google.com/detail/dossi-private-github-note/ogpcmecajeghflaaaennkmknfpeghffm\"\u003eChrome Extension\u003c/a\u003e\n    |\n    \u003ca href=\"https://dossi.dev\"\u003eWebsite\u003c/a\u003e\n    |\n    \u003ca href=\"https://github.com/siegerts/dossi-app\"\u003eWeb app and API repo\u003c/a\u003e\n    |\n     \u003ca href=\"https://github.com/siegerts/dossi-ext/issues\"\u003eFeedback\u003c/a\u003e\n  \u003c/p\u003e\n\n## Introduction\n\nThis is the **browser extension** for dossi, a note-taking app that allows you to [add notes on GitHub issues, pull requests, and more](https://www.dossi.dev/docs).The web app and API are available at [siegerts/dossi-app](https://github.com/siegerts/dossi-app).\n\nYouTube demo: [https://www.youtube.com/watch?v=wgGGjAqa3L8](https://www.youtube.com/watch?v=wgGGjAqa3L8)\n\n## Functionality\n\n- [Sidepanel overlay](https://github.com/siegerts/dossi-ext/blob/main/contents/connct-sidebar.tsx) on GitHub pages to add, edit, and delete notes\n  - Label creation\n  - Pin pages to view later\n  - Note management (create, read, update, delete, sort) with \"light\" markdown support\n- [Popup window](https://github.com/siegerts/dossi-ext/blob/main/popup.tsx) to view recent activity and pins\n- Content script button to open the sidepanel overlay and display the number of notes for the current page\n- [Transferred page detection](https://github.com/siegerts/dossi-ext/blob/main/background.ts#L54) to prompt the user to transfer notes to the new page entity\n- [Bring your own OpenAI API key and prompts](https://www.xiegerts.com/post/browser-extension-genai-key-prompts/) to use with GitHub issue and discussion content\n- Auth integration with dossi web app\n\n## Use Cases\n\n- **Developers**: Keep notes for GitHub issues, pull requests, and discussions\n- **Open Source Contributors**: Keep track of issues and PRs across multiple repositories\n- **Maintainers**: Speed up issue triage, reproduction steps, and PR reviews. Keep track of discussions and decisions\n- **Product Managers**: Track feature requests and user feedback\n\n## Tech Stack\n\n- [Plasmo](https://github.com/PlasmoHQ/plasmo) – browser extension framework\n- [TypeScript](https://www.typescriptlang.org/) – language\n- [shadcn/ui](https://ui.shadcn.com/) – UI components\n- [Tailwind](https://tailwindcss.com/) – CSS\n- [TanStack/react-query](https://react-query.tanstack.com/) – data fetching\n- [zod](https://github.com/colinhacks/zod) – schema validation\n\n## Brower API Compatibility\n\n| API             | Chrome       | Firefox      |\n| --------------- | ------------ | ------------ |\n| `tabs`          | ✅ Supported | ✅ Supported |\n| - `query`       | ✅ Supported | ✅ Supported |\n| - `sendMessage` | ✅ Supported | ✅ Supported |\n| - `onUpdated`   | ✅ Supported | ✅ Supported |\n| `webNavigation` | ✅ Supported | ✅ Supported |\n| `cookies`       | ✅ Supported | ✅ Supported |\n| `runtime`       | ✅ Supported | ✅ Supported |\n\n## User access flow\n\n```mermaid\ngraph TB\n    subgraph \".dev Site\"\n        A[User logs in]\n        L[User logs out]\n        P[API]\n    end\n\n\n    A[User logs in] --\u003e DB[(Neon Postgres Database)]\n    L[User logs out] --\u003e DB[(Neon Postgres Database)]\n    P[API] --\u003e DB[(Neon Postgres Database)]\n\n\n    B --\u003e C{User logged in?}\n    A --\u003e B[User accesses Chrome extension]\n    L --\u003e M[Show unauthenticated UI]\n\n    subgraph \"Content Script\"\n        C --\u003e|Yes| D[\"Show authenticated UI\"]\n        D --\u003e E[\"User can create, read, update, delete notes\"]\n        E --\u003e Z[\"API call to site\"]\n        Z --\u003e P\n        D --\u003e F[User can create, read, update, delete pins]\n        F --\u003e Y[\"API call to site\"]\n        Y --\u003e P\n        D --\u003e G[\"User can create, read, update, delete labels\"]\n        G --\u003e X[\"API call to Main .com site\"]\n        X --\u003e P\n        D --\u003e H{\"API call returns a 403?\"}\n        H --\u003e|Yes| I[Show UI to log in]\n        C --\u003e|No| M\n    end\n\n    subgraph \"Popup Window\"\n        C --\u003e|Yes| K[Popup window shows user information]\n        C --\u003e|No| M\n    end\n\n    style Z fill:#f9a8d4,stroke:#333,stroke-width:2px\n    style Y fill:#f9a8d4,stroke:#333,stroke-width:2px\n    style X fill:#f9a8d4,stroke:#333,stroke-width:2px\n    style DB fill:#e6ffed, stroke:#333, stroke-width:2px\n\n```\n\n## Data flow\n\n```mermaid\ngraph TD\n    subgraph \"Global Providers\"\n        A[AuthProvider - Checks the user data and confirms isAuthed]\n        B[QueryClientProvider]\n        C[UserLabelsProvider - Data fetching]\n    end\n    subgraph \"Page Specific Providers\"\n        D[EntityProvider - Data fetching]\n    end\n    subgraph \"LocalStorage\"\n        F[UserLabels Cache]\n    end\n    E[ActionSheet]\n    A --\u003e B\n    B --\u003e C\n    C --\u003e D\n    D --\u003e E\n    C --\u003e F[Updates Cache]\n    F --\u003e C\n```\n\n## Getting Started\n\n### Install the dependencies\n\n```\npnpm install\n```\n\n### Development\n\n**Environment variables**\n\nCreate a `.env` file in the root of the project with the following content:\n\n```ini\nPLASMO_PUBLIC_HOST=\"http://localhost:3000\"\nPLASMO_PUBLIC_HOST_API=\"http://localhost:3000/api\"\nPLASMO_PUBLIC_HOST_COOKIE=\"next-auth.session-token\"\nPLASMO_PUBLIC_MATCHES=\"https://github.com/*\"\nPLASMO_PUBLIC_MANIFEST_HOST_PERMISSIONS=\"http://localhost:3000/*\"\n```\n\n#### Development build\n\n```bash\npnpm dev\n# or\nnpm run dev\n```\n\nOpen your browser and load the appropriate development build. For example, if you are developing for the chrome browser, using manifest v3, use: `build/chrome-mv3-dev`.\n\nLoad the unpacked extension in your browser.\n\n#### Production build\n\nRun the following:\n\n```bash\npnpm build\n# or\nnpm run build\n```\n\n## License\n\ndossi is open source and available under the [GNU General Public License v3.0(AGPLv3)](LICENSE.md).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsiegerts%2Fdossi-ext","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsiegerts%2Fdossi-ext","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsiegerts%2Fdossi-ext/lists"}