Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pdamianik/frei-vom-bier
Kein Freibier mehr
https://github.com/pdamianik/frei-vom-bier
Last synced: about 2 months ago
JSON representation
Kein Freibier mehr
- Host: GitHub
- URL: https://github.com/pdamianik/frei-vom-bier
- Owner: pdamianik
- License: gpl-3.0
- Created: 2023-10-24T13:46:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-13T09:05:25.000Z (about 1 year ago)
- Last Synced: 2023-11-13T21:27:57.435Z (about 1 year ago)
- Language: TypeScript
- Size: 373 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# frei-vom-bier
This template should help get you started developing a svelte web extension in Vite.
## Usage Notes
The extension manifest is defined in `src/manifest.js` and used by `@samrum/vite-plugin-web-extension` in the vite config.
Background, content scripts, options, and popup entry points exist in the `src/entries` directory.
Content scripts are rendered by `src/entries/contentScript/renderContent.js` which renders content within a ShadowRoot
and handles style injection for HMR and build modes.
Otherwise, the project functions just like a regular Vite project.
To switch between Manifest V2 and Manifest V3 builds, use the MANIFEST_VERSION environment variable defined in `.env`
HMR during development in Manifest V3 requires Chromium version >= 110.0.5480.0.
Refer to [@samrum/vite-plugin-web-extension](https://github.com/samrum/vite-plugin-web-extension) for more usage notes.
## Customize configuration
See [Vite Configuration Reference](https://vitejs.dev/config/).
## Project Setup
```sh
npm install
```
## Commands
### Build
#### Development, HMR
Hot Module Reloading is used to load changes inline without requiring extension rebuilds and extension/page reloads
Currently only works in Chromium based browsers.
```sh
npm run dev
```
#### Development, Watch
Rebuilds extension on file changes. Requires a reload of the extension (and page reload if using content scripts)
```sh
npm run watch
```
#### Production
Minifies and optimizes extension build
```sh
npm run build
```
### Load extension in browser
Loads the contents of the dist directory into the specified browser
```sh
npm run serve:chrome
```
```sh
npm run serve:firefox
```