craftamap / owncast-browser-extension

Owncast Browser Extension is a Firefox extension used to follow various Owncast Instances

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Owncast Browser Extension

release GitHub Workflow Status

Screenshot

Owncast Browser Extension is a Firefox and Chrome/Chromium extension used to follow various Owncast Instances

Installation

The addon can be installed from addons.mozilla.com or from the Chrome Web Store.

Building and Development

This extension uses webpack as build system. For most components, Vue.js and Vuex is used. Sometimes, vanillajs is used though.

tailwindcss is also used.

This Extension is built using yarn. You may also use npm, but yarn is recommended. You can use the following commands:

  • yarn build - Runs webpack and web-ext build. This is used to build the plugin. Use yarn yarn install first. The extension will be outputted into web-ext-artifacts directory.
  • yarn lint - Runs eslint and web-ext lint
  • yarn watch - Runs webpack --watch
  • yarn start - Runs web-ext start. Use together with yarn watch to see your changes in live-time.

Contributing

Pull requests are welcome.

License

MIT

About

Owncast Browser Extension is a Firefox extension used to follow various Owncast Instances

License:MIT License


Languages

Language:JavaScript 46.1%Language:Vue 42.9%Language:SCSS 7.2%Language:TypeScript 3.8%