{"id":25728816,"url":"https://github.com/siddsarkar/browser-extension-starter","last_synced_at":"2026-04-12T15:08:43.415Z","repository":{"id":40344370,"uuid":"472696798","full_name":"siddsarkar/browser-extension-starter","owner":"siddsarkar","description":"Kick Start your browser extension with preconfigured options. :octocat:","archived":false,"fork":false,"pushed_at":"2022-03-22T10:59:47.000Z","size":97,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-19T07:36:25.116Z","etag":null,"topics":["browser-extension","chrome-extension","firefox-extension","tailwindcss","typescript","webpack"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/siddsarkar.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-22T09:31:46.000Z","updated_at":"2022-07-21T07:08:21.000Z","dependencies_parsed_at":"2022-08-27T18:51:42.896Z","dependency_job_id":null,"html_url":"https://github.com/siddsarkar/browser-extension-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siddsarkar%2Fbrowser-extension-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siddsarkar%2Fbrowser-extension-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siddsarkar%2Fbrowser-extension-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siddsarkar%2Fbrowser-extension-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/siddsarkar","download_url":"https://codeload.github.com/siddsarkar/browser-extension-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240770482,"owners_count":19854844,"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":["browser-extension","chrome-extension","firefox-extension","tailwindcss","typescript","webpack"],"created_at":"2025-02-26T00:27:35.431Z","updated_at":"2026-04-12T15:08:43.364Z","avatar_url":"https://github.com/siddsarkar.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# browser-extension-starter\n\n\u003e Cross-browser extension boilerplate - with support for both mv2 and mv3 manifest versions.\n\nScreenshot of extension options:\n\n![Sample extension options output](media/previewer.png)\n\n## Features\n\n-   Get desired extension outputs:\n    -   Firefox (mv2)\n    -   Chromium (mv3)\n-   Use npm dependencies thanks to Webpack.\n-   Out of the box [TypeScript](https://www.typescriptlang.org/) support\n-   Universal api interact with [Extensions API](https://developer.chrome.com/docs/extensions/reference/)\n-   [Tailwind CSS](https://tailwindcss.com/) support out of the box\n\n## Getting started\n\n### 1️⃣ Create your own copy\n\n1. Click [\u003ckbd\u003eUse this template\u003c/kbd\u003e](https://github.com/siddsarkar/browser-extension-starter/generate) to make a copy of your own. 😉\n\n### 🛠 Build locally\n\n1. Checkout the copied repository to your local machine eg. with `git clone https://github.com/my-username/my-awesome-extension/`\n1. Run `npm install` to install all required dependencies\n1. Run `npm run build`\n\nThe build step will create the `dist` folder, this folder will contain the generated extensions for both chrome and firefox\n\n### 🏃 Run the extension\n\nUsing [web-ext](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/) is recommened for automatic reloading and running in a dedicated browser instance. Alternatively you can load the extension manually (see below).\n\n1. Run `npm run dev` to watch and run extensions for chrome and firefox simultaneously\n    \u003e Alternatively you can run `npm run dev:chrome` for chrome and `npm run dev:firefox` for firefox only\n\nThe above step will automatically fire up firefox and chrome with extension loaded, to verify installation go to url [chrome://extensions/](chrome://extensions/) for chrome and [about:addons](about:addons) for firefox\n\n#### Manually\n\nYou can also [load the extension manually in Chrome](https://www.smashingmagazine.com/2017/04/browser-extension-edge-chrome-firefox-opera-brave-vivaldi/#google-chrome-opera-vivaldi) or [Firefox](https://www.smashingmagazine.com/2017/04/browser-extension-edge-chrome-firefox-opera-brave-vivaldi/#mozilla-firefox).\n\n### ✏️ Make the first change\n\n1. For example, edit `\"name\"` key in `manifests\\manifest.chrome.json` to your desired name for your extension\n1. Go back to your browser, reload and see the change take effect\n\nNote: Firefox will automatically reload content scripts when the extension is updated, Chrome requires you to reload the page to reload the content scripts.\n\n### 📕 Read the documentation\n\nHere are some websites you should refer to:\n\n-   [Chrome extensions’ API list](https://developer.chrome.com/docs/extensions/reference/)\n-   [Firefox WebExtensions API list](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions)\n\n## License\n\n\u003cp xmlns:dct=\"http://purl.org/dc/terms/\" xmlns:vcard=\"http://www.w3.org/2001/vcard-rdf/3.0#\"\u003e\n    To the extent possible under law,\n    \u003ca rel=\"dct:publisher\" href=\"https://siddsarkar.github.io/\"\u003e\n        \u003cspan property=\"dct:title\"\u003eSiddhartha Sarkar\u003c/span\u003e\n    \u003c/a\u003e\n    has waived all copyright and related or neighboring rights to\n    \u003cspan property=\"dct:title\"\u003ebrowser-addon-template\u003c/span\u003e.\n    This work is published from: \u003cspan property=\"vcard:Country\" datatype=\"dct:ISO3166\" content=\"IN\" about=\"https://siddsarkar.github.io/\"\u003eIndia\u003c/span\u003e.\n    \u003cbr/\u003e\n    \u003ca rel=\"license\" href=\"http://creativecommons.org/publicdomain/zero/1.0/\"\u003e\n        \u003cimg src=\"https://licensebuttons.net/p/zero/1.0/88x31.png\" style=\"border-style: none;\" alt=\"CC0\" /\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsiddsarkar%2Fbrowser-extension-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsiddsarkar%2Fbrowser-extension-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsiddsarkar%2Fbrowser-extension-starter/lists"}