Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smashedr/site-tools
Upcoming Web Extension with Various Site Modifications
https://github.com/smashedr/site-tools
Last synced: about 1 month ago
JSON representation
Upcoming Web Extension with Various Site Modifications
- Host: GitHub
- URL: https://github.com/smashedr/site-tools
- Owner: smashedr
- License: gpl-3.0
- Created: 2024-07-04T02:42:07.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-08-16T22:45:37.000Z (6 months ago)
- Last Synced: 2024-11-10T15:50:50.613Z (3 months ago)
- Language: JavaScript
- Homepage: https://cssnr.github.io
- Size: 249 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/smashedr/site-tools/releases/latest)
[](https://github.com/smashedr/site-tools/graphs/commit-activity)
[](https://github.com/smashedr/site-tools)
[](https://cssnr.github.io/)
[](https://discord.gg/6pzXJE5)# Site Tools
Modern Chrome Web Extension and Firefox Browser Addon Site Tools Example.
[README.md](README.md) copied from [link-extractor](https://github.com/cssnr/link-extractor) as an example.* [Install](#install)
* [Features](#features)
* [Configuration](#configuration)
* [Development](#development)
- [Building](#building)
* [Contributing](#Contributing)# Install
* [Google Chrome Web Store](https://github.com/smashedr/site-tools/releases/latest)
* [Mozilla Firefox Add-ons](https://github.com/smashedr/site-tools/releases/latest)[](https://github.com/smashedr/site-tools/releases/latest)
[](https://github.com/smashedr/site-tools/releases/latest)
[](https://github.com/smashedr/site-tools/releases/latest)
[](https://github.com/smashedr/site-tools/releases/latest)
[](https://github.com/smashedr/site-tools/releases/latest)
[](https://github.com/smashedr/site-tools/releases/latest)
[](https://github.com/smashedr/site-tools/releases/latest)All **Chromium** Based Browsers can install the extension from the
[Chrome Web Store](https://github.com/smashedr/site-tools/releases/latest).# Features
- Flaticon - https://www.flaticon.com/
- Fontawesome - https://fontawesome.com/Please submit a [Feature Request](https://github.com/smashedr/site-tools/discussions/categories/feature-requests) for
new features.
For any issues, bugs or concerns; please [Open an Issue](https://github.com/smashedr/site-tools/issues).# Configuration
You can pin the Addon by clicking the `Puzzle Piece`, find the Web Extension icon, then;
**Chrome,** click the `Pin` icon.
**Firefox,** click the `Settings Wheel` and `Pin to Toolbar`.To open the options, click on the icon (from above) then click `Open Options`.
# Development
**Quick Start**
First, clone (or download) this repository and change into the directory.
Second, install the dependencies:
```shell
npm install
```Finally, to run Chrome or Firefox with web-ext, run one of the following:
```shell
npm run chrome
npm run firefox
```Additionally, to Load Unpacked/Temporary Add-on make a `manifest.json` and run from the [src](src) folder, run one of
the following:```shell
npm run manifest:chrome
npm run manifest:firefox
```Chrome: [https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked)
Firefox: [https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/)For more information on
web-ext, [read this documentation](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/).
To pass additional arguments to an `npm run` command, use `--`.
Example: `npm run chrome -- --chromium-binary=...`## Building
Install the requirements and copy libraries into the `src/dist` directory by running `npm install`.
See [gulpfile.js](gulpfile.js) for more information on `postinstall`.```shell
npm install
```To create a `.zip` archive of the [src](src) directory for the desired browser run one of the following:
```shell
npm run build
npm run build:chrome
npm run build:firefox
```For more information on building, see the scripts section in the [package.json](package.json) file.
## Chrome Setup
1. Build or Download a [Release](https://github.com/smashedr/site-tools/releases).
1. Unzip the archive, place the folder where it must remain and note its location for later.
1. Open Chrome, click the `3 dots` in the top right, click `Extensions`, click `Manage Extensions`.
1. In the top right, click `Developer Mode` then on the top left click `Load unpacked`.
1. Navigate to the folder you extracted in step #3 then click `Select Folder`.## Firefox Setup
1. Build or Download a [Release](https://github.com/smashedr/site-tools/releases).
1. Unzip the archive, place the folder where it must remain and note its location for later.
1. Go to `about:debugging#/runtime/this-firefox` and click `Load Temporary Add-on...`
1. Navigate to the folder you extracted earlier, select `manifest.json` then click `Select File`.
1. Optional: Open `about:config` search for `extensions.webextensions.keepStorageOnUninstall` and set to `true`.If you need to test a restart, you must pack the addon. This only works in ESR, Development, or Nightly.
You may also use an Unbranded
Build: [https://wiki.mozilla.org/Add-ons/Extension_Signing#Unbranded_Builds](https://wiki.mozilla.org/Add-ons/Extension_Signing#Unbranded_Builds)1. Run `npm run build:firefox` then use `web-ext-artifacts/{name}-firefox-{version}.zip`.
1. Open `about:config` search for `xpinstall.signatures.required` and set to `false`.
1. Open `about:addons` and drag the zip file to the page or choose Install from File from the Settings wheel.# Contributing
Currently, the best way to contribute to this project is to give a 5-star rating on
[Google](https://chromewebstore.google.com/detail/smwc-web-extension/foalfafgmnglcgpgkhhmcfhjgmdcjide) or
[Mozilla](https://addons.mozilla.org/addon/smwc-web-extension) and to star this project on GitHub.Other Web Extensions I have created and published:
- [Link Extractor](https://github.com/cssnr/link-extractor)
- [Open Links in New Tab](https://github.com/cssnr/open-links-in-new-tab)
- [HLS Video Downloader](https://github.com/cssnr/hls-video-downloader)
- [SMWC Web Extension](https://github.com/cssnr/smwc-web-extension)
- [PlayDrift Extension](https://github.com/cssnr/playdrift-extension)
- [ASN Plus](https://github.com/cssnr/asn-plus)
- [Aviation Tools](https://github.com/cssnr/aviation-tools)
- [Text Formatter](https://github.com/cssnr/text-formatter)For a full list of current projects visit: [https://cssnr.github.io/](https://cssnr.github.io/)