{"id":13477175,"url":"https://github.com/BCIT-DDC/web-extension-ts-starter","last_synced_at":"2025-03-27T04:32:43.983Z","repository":{"id":37403328,"uuid":"444326832","full_name":"BCIT-DDC/web-extension-ts-starter","owner":"BCIT-DDC","description":"🚀 A web extension starter built with React, Typescript, and Tailwind CSS. Build once, and run on multiple browsers: Google Chrome, Mozilla Firefox, Microsoft Edge, Brave, and Opera.","archived":false,"fork":false,"pushed_at":"2023-07-12T05:39:55.000Z","size":914,"stargazers_count":39,"open_issues_count":0,"forks_count":8,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-30T09:36:02.109Z","etag":null,"topics":["brave-extension","chrome-extension","extension","firefox-extension","hackathon","jest","react","starter","tailwindcss","template","typescript","webpack5"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/BCIT-DDC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"bcit-ddc"}},"created_at":"2022-01-04T07:33:39.000Z","updated_at":"2024-08-12T20:19:28.000Z","dependencies_parsed_at":"2024-01-13T19:30:14.313Z","dependency_job_id":null,"html_url":"https://github.com/BCIT-DDC/web-extension-ts-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/BCIT-DDC%2Fweb-extension-ts-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BCIT-DDC%2Fweb-extension-ts-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BCIT-DDC%2Fweb-extension-ts-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BCIT-DDC%2Fweb-extension-ts-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BCIT-DDC","download_url":"https://codeload.github.com/BCIT-DDC/web-extension-ts-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245785591,"owners_count":20671628,"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":["brave-extension","chrome-extension","extension","firefox-extension","hackathon","jest","react","starter","tailwindcss","template","typescript","webpack5"],"created_at":"2024-07-31T16:01:39.040Z","updated_at":"2025-03-27T04:32:43.977Z","avatar_url":"https://github.com/BCIT-DDC.png","language":"JavaScript","funding_links":["https://github.com/sponsors/bcit-ddc"],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003cdiv id=\"top\"\u003e\u003c/div\u003e\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\n  \u003ca align=\"left\" href=\"https://github.com/BCIT-DDC\"\u003e\n    \u003cimg src=\"./assets/images/DDC-rounded.png\" alt=\"Logo\" width=\"40\" height=\"40\"\u003e\n  \u003c/a\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## Web Extension Starter\n\n\u003c!-- \u003cp align=\"center\"\u003e\n    \u003cimg alt=\"Search\" src=\"./assets/images/SearchBarScreenshot.JPG\" src=\"./assets/video/SearchBarDemo.gif\" width=\"100%\"/\u003e\n\u003c/p\u003e --\u003e\n\nA web extension starter, built with React, Typescript, and Tailwind CSS. Build once, and run on multiple browsers: Google Chrome, Mozilla Firefox, Microsoft Edge, and Brave.\n\n### Built With\n\n-   ![React](https://img.shields.io/badge/-React-050B1E?\u0026logo=React)\n-   ![TypeScript](https://img.shields.io/badge/-TypeScript-050B1E?\u0026logo=TypeScript)\n-   ![Webpack](https://img.shields.io/badge/-Webpack.js-050B1E?\u0026logo=webpack)\n-   ![TailwindCSS](https://img.shields.io/badge/-Tailwind_CSS-050B1E?\u0026logo=tailwind-css)\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started\n\n### 1. Download starter and install dependencies\n\nClone this repository:\n\n```\ngit clone git@github.com:BCIT-DDC/web-extension-ts-starter.git\n```\n\nInstall npm dependencies:\n\n```\ncd web-extension-ts-starter\nnpm install\n```\n\n### 2. Build the Extension\n\n#### Start the Webpack Development Server\n\n```\nnpm run dev\n```\n\n#### Build the Production-Ready Extension\n\n```\nnpm run build\n```\n\nThe relevant web extension files will be present in the output `.dist/` folder.\n\n\u003c!-- USAGE EXAMPLES --\u003e\n\n## Usage\n\n--\n\n\u003c!-- ROADMAP --\u003e\n\n## Roadmap\n\n\u003c!-- -   [x] Add Changelog --\u003e\n\n-   [ ] Add support for Opera\n\nSee the [open issues](https://github.com/BCIT-DDC/web-extension-ts-starter/issues) for a full list of proposed features (and known issues).\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you would like to contribute, please have a look at our [contributing guidelines](https://github.com/BCIT-DDC/docs/blob/main/contributing.md).\n\n### Contributors\n\nThis project exists thanks to all the people who contribute.\n\u003cbr/\u003e\n\u003ca href=\"https://github.com/BCIT-DDC/web-extension-ts-starter/graphs/contributors\"\u003e\n\u003cimg src=\"https://contrib.rocks/image?repo=bcit-ddc/web-extension-ts-starter\" width=\"40\" height=\"40\"/\u003e\n\u003c/a\u003e\n\n\u003c!-- TESTING --\u003e\n\n\u003c!-- ## TESTING --\u003e\n\n\u003c!-- LINTING --\u003e\n\n\u003c!-- ## Linting --\u003e\n\n\u003c!-- LICENSE --\u003e\n\n## License\n\n[MIT](LICENSE.md) © BCIT-DDC\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n\n## Acknowledgments\n\n- [Heroicons](https://heroicons.com/)\n- [Headless UI](https://headlessui.dev/)\n\n## Status\n\u003cp align=\"center\"\u003e\n    \u003cimg alt=\"Search\" src=\"https://repobeats.axiom.co/api/embed/67a1ec304f49e3cc25a9b5e5ba7a8e1e04d27e20.svg\" width=\"100%\"/\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBCIT-DDC%2Fweb-extension-ts-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBCIT-DDC%2Fweb-extension-ts-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBCIT-DDC%2Fweb-extension-ts-starter/lists"}