JosunLP/BrowserExtensionTemplate
1
0
Fork 0
mirror of https://github.com/JosunLP/BrowserExtensionTemplate.git synced 2025-06-21 18:11:08 +00:00
Code Issues Projects Releases Wiki Activity Actions

working on readme

Browse source
This commit is contained in:
Jonas Pfalzgraf 2022-08-15 18:11:14 +02:00
parent 60bc8c71e9
commit 385be01143
2 changed files with 15 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,2 +1,15 @@
# BrowserExtensionTemplate # BrowserExtensionTemplate
A basic template based on SASS and TypeScript to create browser extensions without directly relying on a larger framework. 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`.
## 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.

4
src/sass/_root.sass
View file

@ -3,6 +3,6 @@ $main-font-color: white
$main-font-color-hover: lightgrey $main-font-color-hover: lightgrey
$main-uschrift-font: 'Ubuntu', Arial $main-uschrift-font: 'Ubuntu', Arial
$seccond-color: lightgrey $seccond-color: lightgrey
$background-color: rgb(77, 153, 252) $background-color: rgb(119, 178, 255)
$background-color-content: rgb(149, 195, 255) $background-color-content: rgb(198, 223, 255)
$logo-image: url('../icons/icon128.png') $logo-image: url('../icons/icon128.png')