Code Monkey home page Code Monkey logo

davidnguyen11 / web-extension-svelte-boilerplate Goto Github PK

View Code? Open in Web Editor NEW
59.0 3.0 9.0 564 KB

The web extension boilerplate which helps setting up browser extension project quickly using typescript, svelte, jest, webpack, githook, prettier and github actions

License: MIT License

HTML 3.27% TypeScript 47.56% Svelte 9.43% CSS 0.14% JavaScript 37.28% Shell 2.33%
chrome-extension firefox-addon webpack jest prettier microsoft-edge-extension cicd github-actions svelte testing-library

web-extension-svelte-boilerplate's Introduction

Web Extension Svelte Boilerplate



This boilerplate using Svelte provides a skeleton to start developing cross-browser web extensions.

All Contributors

codecov ci/cd code style: prettier PRs Welcome MIT license

Development

npm i

Chrome

npm run app:chrome-dev

Edge

npm run app:edge-dev

Firefox

npm run app:firefox-dev

Production

npm i
npm run app:chrome

Edge

npm run app:edge

Firefox

npm run app:firefox

Load package to browsers

Chrome

  1. Go to the browser's URL address bar
  2. Enter chrome://extensions/
  3. Switch to "Developer mode"
  4. Load extension by clicking "Load unpacked"
  5. Browse to dist/ in source code
  6. Done!

Check here for more detail: https://developer.chrome.com/extensions/getstarted

Edge

  1. Go to the browser's URL address bar
  2. Enter edge://extensions/
  3. Turn on Developer mode
  4. Load extension by clicking "Load unpacked"
  5. Browse to dist/ in source code
  6. Done!

Firefox

  1. Go to the browser's URL address bar
  2. Enter about:debugging#/runtime/this-firefox
  3. Click Load Temporary Add-on...
  4. Browse to your manifest.json & click Open
  5. Done!

Check here for more details: https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/

How to keep devtool appears when developing

Simple, just open chrome extension as a page. To do that, follow below steps:

  1. Open extension management page

Screen Shot 2021-05-27 at 14 44 56

  1. Copy extension id

Screen Shot 2021-05-27 at 14 45 20

  1. Open extension as a page chrome-extension://<extension-id>/popup.html
  • For example: chrome-extension://npjcjlkchmiidojhockoecphakigbaej/popup.html

chrome-extension://npjcjlkchmiidojhockoecphakigbaej/popup.html

Privacy Policy file

Web stores require you to describe what the extension is or if you collect data of users. You also need to describe why you do that.

Make sure you include this file when you publish an extension, the web store may ask you to upload it.

Note: If you don't know how to write a privacy policy file, you can look at the existing one attached on this repository.

Badges

You can add badges to your project to indicate the version or to show how many users use your extension here:

CI/CD with github action

You can modify the .github/workflows to show the CI/CD flow.

How to publish web extension

Browsers Web store
Chrome https://developer.chrome.com/webstore/publish
Microsoft Edge https://docs.microsoft.com/en-us/microsoft-edge/extensions-chromium/publish/publish-extension
Firefox https://extensionworkshop.com/documentation/publish/submitting-an-add-on

References

Most important

Follow me on Twitter! https://twitter.com/davidnguyen1791

Thanks!

License

MIT

Contributors โœจ

Thanks goes to these wonderful people (emoji key):


David Nguyen

๐Ÿ’ป ๐Ÿ“– ๐ŸŽจ ๐Ÿค” ๐Ÿš‡ ๐Ÿšง ๐Ÿ‘€ โš ๏ธ

DK

๐Ÿ’ป ๐Ÿค” ๐Ÿš‡ ๐Ÿšง ๐Ÿ‘€ โš ๏ธ

This project follows the all-contributors specification. Contributions of any kind welcome!

web-extension-svelte-boilerplate's People

Contributors

allcontributors[bot] avatar conandk avatar davidnguyen10 avatar davidnguyen11 avatar khoado-ct avatar mingo023 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

web-extension-svelte-boilerplate's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.