Overview:
The Extension Starter Kit is a tool designed for developers looking to build Chrome or Firefox extensions. It provides a starting point for creating extensions with support for TypeScript, React, Bootstrap, CSS Modules, and live reloading.
Features:
- TypeScript: Write your extension code in TypeScript for improved type safety and developer productivity.
- React: Use React to build dynamic and interactive user interfaces for your extension.
- Bootstrap: Utilize the Bootstrap framework to easily create responsive and visually appealing designs.
- CSS Modules: Keep your styles modular and manageable with CSS Modules, preventing conflicts and improving code organization.
- Live Reloading: Enable live reloading during development, allowing for quick and seamless updates without needing to manually refresh the extension.
Installation:
To install the Extension Starter Kit, follow these steps:
- Clone or download the repository to your local machine.
- Open a command prompt or terminal and navigate to the project directory.
- Run
npm installto install the necessary dependencies. - Depending on your desired development environment:
- For Chrome:
- Run
npm run developto start the webpack-dev-server. - Open
chrome://extensions/in your Chrome browser. - Load the extension from the
dist-devdirectory.
- Run
- For Firefox:
- Run
npm run develop-firefoxto start the webpack-dev-server. - Load
build/manifest.jsonfromabout:debugging#/runtime/this-firefoxin your Firefox browser.
- Run
- For Chrome:
- The extension will be automatically updated through live reload or hot module replacement, except for content scripts which may require a manual refresh.
Summary:
The Extension Starter Kit is a versatile tool that provides a solid foundation for building Chrome and Firefox extensions. With support for TypeScript, React, Bootstrap, CSS Modules, and live reloading, developers can create powerful and visually appealing extensions with ease. The installation process is straightforward, allowing developers to quickly set up their development environment and start building their extensions.