mirror of
https://github.com/JosunLP/BrowserExtensionTemplate.git
synced 2025-06-21 18:11:08 +00:00
38 lines
2.6 KiB
Markdown
38 lines
2.6 KiB
Markdown
# BrowserExtensionTemplate
|
|
|
|
[](https://github.com/JosunLP/BrowserExtensionTemplate/issues)
|
|
[](https://github.com/JosunLP/BrowserExtensionTemplate/network)
|
|
[](https://github.com/JosunLP/BrowserExtensionTemplate/stargazers)
|
|
[](https://github.com/JosunLP/BrowserExtensionTemplate)
|
|
[](https://twitter.com/intent/tweet?text=Look+what+i+found+on+GitHub+%23Developer%2C+%23SoftwareDeveloper%3A&url=https%3A%2F%2Fgithub.com%2FJosunLP%2FBrowserExtensionTemplate)
|
|
[](https://www.codefactor.io/repository/github/josunlp/browserextensiontemplate)
|
|
[](https://snyk.io/test/github/JosunLP/BrowserExtensionTemplate)
|
|
|
|
## 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](https://github.com/JosunLP/BrowserExtensionTemplate). 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](https://opensource.org/licenses/MIT).
|
|
|
|
## Contributing
|
|
|
|
This project is open source. Feel free to fork and contribute!
|
|
|
|
## Author
|
|
|
|
Jonas Pfalzgraf
|