Web Extension Starter

screenshot of Web Extension Starter
react
scss

Web Extension Starter

🖥🔋Web Extension starter to build "Write Once Run on Any Browser" extension

Overview:

This product is a web browser extension template that allows developers to quickly create extensions for Chrome, Firefox, Opera, and other browsers. It utilizes React, TypeScript, and HTML for the frontend, and provides features such as cross-browser support, automatic builds, SASS styling, and a React UI library. It is used by several popular extensions with a large user base.

Features:

  • Cross Browser Support: The template supports multiple browsers including Chrome, Firefox, Opera, and more using the Web-Extensions API.
  • Browser Tailored Manifest Generation: The template automatically generates the manifest file tailored for each browser, saving development time.
  • Automatic Build on Code Changes: Builds are triggered automatically whenever the code changes, making development more efficient.
  • Auto Packs Browser Specific Build Files: The template automatically packs the browser-specific build files, eliminating the need for manual packing.
  • SASS Styling: The template supports SASS styling, providing a more organized and efficient way to style the extension.
  • TypeScript by Default: TypeScript is the default language used in the template, offering static typing and improved development experience.
  • ES6 Modules Support: The template supports ES6 modules, allowing developers to organize their code using modern JavaScript modules.
  • React UI Library by Default: The template comes with a React UI library by default, making it easier to build a user interface for the extension.

Installation:

To use this extension template, follow these steps:

  1. Create a new directory.
  2. Install Node.js 10 or later.
  3. Install Yarn v1 or v2.
  4. Run yarn install in the directory to install dependencies.
  5. Run one of the following commands to start the development server:
    • yarn run dev:chrome for Chrome extension.
    • yarn run dev:firefox for Firefox addon.
    • yarn run dev:opera for Opera extension.
  6. Run one of the following commands to build the extension:
    • yarn run build:chrome to build the Chrome extension.
    • yarn run build:firefox to build the Firefox addon.
    • yarn run build:opera to build the Opera extension.
  7. (Optional) Run yarn run build to build and pack all extensions at once.

Summary:

This web browser extension template provides an easy and efficient way to create extensions for popular browsers. With features like cross-browser support, automatic builds, and a React UI library, it simplifies the development process and reduces manual tasks. It is already being used by several popular extensions with a large user base.

react
React

React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components

scss
SCSS

SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.

eslint
Eslint

ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.

postcss
Postcss

PostCSS is a popular open-source tool that enables web developers to transform CSS styles with JavaScript plugins. It allows for efficient processing of CSS styles, from applying vendor prefixes to improving browser compatibility, ultimately resulting in cleaner, faster, and more maintainable code.

typescript
Typescript

TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.

webpack
Webpack

Webpack is a popular open-source module bundler for JavaScript applications that bundles and optimizes the code and its dependencies for production-ready deployment. It can also be used to transform other types of assets such as CSS, images, and fonts.