Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stefanvd/browser-extension-starter-template

Chrome extension template - For Beginners with the necessary dev function
https://github.com/stefanvd/browser-extension-starter-template

chrome-extension chrome-extensions development google-chrome google-chrome-extension manifest-v3 starter-kit starter-template

Last synced: 4 months ago
JSON representation

Chrome extension template - For Beginners with the necessary dev function

Awesome Lists containing this project

README

        

# browser-extension-starter-template
Chrome extension template - For Beginners with the necessary dev function
For Google Chrome web browser
and for other browsers such as
Google Chrome, Firefox, Opera, Safari, Maxthon, Yandex, Brave, Vivaldi, Cốc Cốc, Microsoft Edge, and Naver Whale.

## For who?
This is the starter template for new developers, fresh developers that want to get started with building an amazing web experience in their web browser. This template includes all the basics you need with a concisely writing tool and dark mode support. And easy export function to upload it to the web store.

## What I need to learn?
+ You need to learn only the vanila JavaScript
+ CSS
+ HTML
+ JSON

# Template
+ Manifest V3 support
+ Support for Dark Mode and Light Mode
+ Options page

Support for Windows and Mac

# Development
+ Use ESLint
+ Use less external dev library
+ One command to package the zip file for the Chrome Web Store

# How to get started?
1. Open Terminal (on Mac) and Prompt (on Windows)
2. Type `git clone`, and then paste the URL you copied earlier.
```
git clone https://github.com/stefanvd/browser-extension-starter-template
```
3. Press `Enter` to create your local clone.

# Packaging
Run `npm run dist` to create a zipped, production-ready extension for each browser. You can then upload that to the web store.

This template is used for the most popular [Turn Off the Lights browser extension](https://github.com/turnoffthelights/Turn-Off-the-Lights-Chrome-extension). Turn Off the Lights is a free and Open-Source browser extension. https://www.turnoffthelights.com