{"id":15357860,"url":"https://github.com/mefengl/wxt-starter","last_synced_at":"2025-07-15T10:39:28.915Z","repository":{"id":232177423,"uuid":"728254410","full_name":"mefengl/wxt-starter","owner":"mefengl","description":"Maybe the best template based on wxt.","archived":false,"fork":false,"pushed_at":"2025-02-27T17:13:18.000Z","size":549,"stargazers_count":83,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-09T18:18:28.150Z","etag":null,"topics":["chrome-extension","firefox","safari","wxt"],"latest_commit_sha":null,"homepage":"","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/mefengl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2023-12-06T14:56:33.000Z","updated_at":"2025-03-29T09:50:29.000Z","dependencies_parsed_at":"2024-04-18T02:45:50.757Z","dependency_job_id":"faeae196-c940-4557-b1d2-9e79218443d8","html_url":"https://github.com/mefengl/wxt-starter","commit_stats":{"total_commits":91,"total_committers":1,"mean_commits":91.0,"dds":0.0,"last_synced_commit":"6c4bb3486c620e736b81a79eb9d9d40d3d15ecb0"},"previous_names":["mefengl/wxt-starter"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mefengl%2Fwxt-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mefengl%2Fwxt-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mefengl%2Fwxt-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mefengl%2Fwxt-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mefengl","download_url":"https://codeload.github.com/mefengl/wxt-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248085326,"owners_count":21045139,"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":["chrome-extension","firefox","safari","wxt"],"created_at":"2024-10-01T12:39:21.173Z","updated_at":"2025-04-09T18:18:33.329Z","avatar_url":"https://github.com/mefengl.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# WXT Starter\n\nBuild upon amazing [wxt](wxt.dev) framework.\n\n## Requirements\n\n- [bun](https://bun.sh/)\n\n## Addons\n\n- [tailwindcss](https://tailwindcss.com)\n- [shadcn/ui](https://ui.shadcn.com)\n- [@wxt-dev/i18n](https://wxt.dev/guide/i18n/introduction)\n\ndev:\n\n- [eslint-config](https://github.com/antfu/eslint-config): See [eslint](#eslint)\n- [bumpp](https://github.com/antfu-collective/bumpp): use `bun bump`\n\n## Setup\n\n- [ ] update `name` in `package.json`, it will be zip file name\n- [ ] update `title` and `description` in `src/locales`, these will appear in the Chrome Web Store\n- [ ] update `default_locale` in `wxt.config.js` if not `en`\n- [ ] replace `icon.png` in `src/assets`\n- [ ] run `bun bump minor`\n- [ ] [mvp](https://en.wikipedia.org/wiki/Minimum_viable_product)\n- [ ] run `bun bump major`\n- [ ] publish\n\noptional:\n\n- [ ] update `README.md`\n- [ ] add extension url to `README.md`\n- [ ] setup [cli submit](#cli-submit)\n\n## Predefined Entrypoints\n\n**Find more at [wxt.dev/examples](https://wxt.dev/examples.html)**\n\nMove the predefined entry points from the `entrypoints.inactive` folder to directly in the `entrypoints` folder to enable them.\n\nPopup is enabled by default.\n\n*: For `sidepanel`, wxt does not automatically add the `sidePanel` permission. You must manually add it to the `manifest` field in `wxt.config.js`. Related: [wxt#544](https://github.com/wxt-dev/wxt/issues/544)\n\n*: For `onboarding`, to retrieve the URL of the onboarding page, use `browser.runtime.getURL('/onboarding.html')`.\n\n## eslint\n\nIf you are using vscode, autofix should already be enabled. You can run `bun lint` to check for errors and `bun lint:fix` to fix most of them.\n\n\u003e Thanks for antfu's elegant design philosophy in eslint configuration.\n\n## shadcn/ui\n\nTo use it, refer to the [documentation](https://ui.shadcn.com/docs/cli#add)\n\n\u003e tldr: To add components using `npx shadcn@latest add`, select them by pressing `space` and submit with `enter`. If adding a code file, simply type the component name for autocompletion in vscode.\n\n## Advanced Configuration\n\n### cli submit\n\n0. You need to manually upload the extension to the Chrome Web Store the first time. After that, you can get the `CHROME_EXTENSION_ID`.\n\n1. Rename the file `.env.submit.example` to `.env.submit` and fill in the `CHROME_EXTENSION_ID`.\n\n2. Add the following settings to your shell config file. Keep them safe. See https://github.com/fregante/chrome-webstore-upload-keys for how to get the keys.\n\n   ```shell\n   export CHROME_CLIENT_ID=\"\u003cyour client id\u003e\"\n   export CHROME_REFRESH_TOKEN=\"\u003cyour refresh token\u003e\"\n   export CHROME_CLIENT_SECRET=\"\u003cyour client secret\u003e\"\n   ```\n\n3. Now you can run `bun submit:latest` for faster submission.\n\n \u003e `bun submit:latest` is an alias for `bun exec 'rm -rf .output'; wxt zip \u0026\u0026 wxt submit --chrome-zip .output/*.zip`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmefengl%2Fwxt-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmefengl%2Fwxt-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmefengl%2Fwxt-starter/lists"}