Skip to content

JosunLP/BrowserExtensionTemplate

Repository files navigation

BrowserExtensionTemplate

GitHub issues GitHub forks GitHub stars GitHub license Twitter URL CodeFactor Known Vulnerabilities

Description

A basic template based on SASS and TypeScript to create browser extensions without directly relying on a larger framework.

Installation

You can download the source code from GitHub. Just copy it in your project and run npm install to install the dependencies. The basic configuration, wich will sync with npm run sync with the package.json file and the manifest.json file, is in app.config.json. Alternatively, you can fork the project and run npm install in the forked project.

Usage

Your sourcecode can be written in the src folder. The public folder contains static files like images, html and the manifest.json. With the npm run deploy-v3 command you can deploy the extension to the dist folder, ready to be published to the chrome web store. With the npm run deploy-v2 command you can deploy the extension to the dist folder, ready to be published to the firefox web store. This is necessary because the firefox web store needs the manifest.json file to be present in the version v2.

License

This project is licensed under the MIT license.

Contributing

This project is open source. Feel free to fork and contribute!

Author

Jonas Pfalzgraf