{"id":20318073,"url":"https://github.com/deadcoder0904/redact-the-web","last_synced_at":"2025-07-14T03:40:41.597Z","repository":{"id":42321172,"uuid":"209824270","full_name":"deadcoder0904/redact-the-web","owner":"deadcoder0904","description":"Redact The Web - A Browser Extension that redacts the web with a click of a button","archived":false,"fork":false,"pushed_at":"2023-01-04T10:54:33.000Z","size":4568,"stargazers_count":2,"open_issues_count":16,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-14T13:17:54.752Z","etag":null,"topics":["browser-extension","chrome-extension","firefox-addon","firefox-extension","redact-the-web","web-extension"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deadcoder0904.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-20T15:33:00.000Z","updated_at":"2019-10-05T06:16:19.000Z","dependencies_parsed_at":"2023-02-02T09:32:25.397Z","dependency_job_id":null,"html_url":"https://github.com/deadcoder0904/redact-the-web","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deadcoder0904%2Fredact-the-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deadcoder0904%2Fredact-the-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deadcoder0904%2Fredact-the-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deadcoder0904%2Fredact-the-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deadcoder0904","download_url":"https://codeload.github.com/deadcoder0904/redact-the-web/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241818899,"owners_count":20025212,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["browser-extension","chrome-extension","firefox-addon","firefox-extension","redact-the-web","web-extension"],"created_at":"2024-11-14T18:38:01.849Z","updated_at":"2025-03-04T09:17:32.559Z","avatar_url":"https://github.com/deadcoder0904.png","language":"JavaScript","readme":"# redact-the-web\n\n\u003e Redacts text on the web. Works on both Chrome \u0026 Firefox 😜\n\n![Redact The Web](./screenshots/redact-the-web.gif)\n\n## Installation\n\nInstall the [Chrome extension manually](https://superuser.com/a/247654) from `release/chrome` folder or install the [Firefox extension manually](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Temporary_Installation_in_Firefox) from `release/firefox` folder.\n\n## Development\n\nInstall all the dependencies using `yarn`.\n\nWrite your code in `background.js` \u0026 `content.js`.\n\nTo transpile it, run `yarn prod` in the terminal. This will generate `release/` folder.\n\n`release/` folder contains `chrome/`, `firefox/` \u0026 `zip/` folder.\n\n`chrome/` folder contains transpiled code that can be run in Google Chrome.\n\n`firefox/` folder contains transpiled code that can be run in Mozilla Firefox.\n\n`zip/` folder contains `.zip` files of both Chrome \u0026 Firefox.\n\n## Generate Extension Icons\n\nDownload \u0026 Install [Image Magick](https://www.imagemagick.org/).\n\nGo to `icons` folder \u0026 put an `icon128.png` in the folder.\n\nThen run `./generate_icons.sh` to generate rest of the icons.\n\n## npm scripts\n\n```json\n\"scripts\": {\n\t\"clean\": \"rimraf release/chrome release/firefox release/zip\",\n\t\"clean:redundant\": \"rimraf release/**/generate_icons.sh release/**/*.js.map\",\n\t\"clean:zip\": \"rimraf release/chrome/*.zip release/firefox/*.zip\",\n\t\"build:parcel:firefox\": \"parcel build background.js content.js --out-dir release/firefox\",\n\t\"build:parcel:chrome\": \"parcel build background.js content.js --out-dir release/chrome\",\n\t\"copy:firefox\": \"cpy 'manifest.firefox.json' 'style.firefox.css' 'Redacted-Regular.ttf' 'icons' 'release/firefox'\",\n\t\"copy:chrome\": \"cpy 'manifest.chrome.json' 'style.chrome.css' 'Redacted-Regular.ttf' 'icons' 'release/chrome'\",\n\t\"rename:firefox\": \"rename 'release/firefox/manifest.firefox.json' 'release/firefox/manifest.json' \u0026\u0026 rename 'release/firefox/style.firefox.css' 'release/firefox/style.css'\",\n\t\"rename:chrome\": \"rename 'release/chrome/manifest.chrome.json' 'release/chrome/manifest.json' \u0026\u0026 rename 'release/chrome/style.chrome.css' 'release/chrome/style.css'\",\n\t\"zip:firefox\": \"web-ext build --source-dir release/firefox --artifacts-dir release/firefox\",\n\t\"zip:chrome\": \"web-ext build --source-dir release/chrome --artifacts-dir release/chrome\",\n\t\"rename:zip:firefox\": \"rename release/firefox/*.zip 'release/firefox/{{f}}-firefox'\",\n\t\"rename:zip:chrome\": \"rename release/chrome/*.zip 'release/chrome/{{f}}-chrome'\",\n\t\"copy:zip:firefox\": \"cpy 'release/firefox/*.zip' 'release/zip/'\",\n\t\"copy:zip:chrome\": \"cpy 'release/chrome/*.zip' 'release/zip/'\",\n\t\"magick\": \"cd screenshots \u0026\u0026 magick mogrify -resize 1280x800! *.png\",\n\t\"prod\": \"npm-run-all clean build:parcel:* copy:* rename:* clean:redundant zip:* rename:zip:* copy:zip:* clean:zip\",\n\t\"package:chrome\": \"'/Applications/Google Chrome.app/Contents/MacOS/Google Chrome' --pack-extension=./release/chrome --pack-extension-key=./release/chrome.pem\",\n\t\"package:firefox\": \"web-ext sign --api-key=$API_KEY --api-secret=$API_SECRET --source-dir release/firefox --artifacts-dir release/\"\n}\n```\n\n## Description\n\n# clean\n\n\u003e Remove the `release/chrome`, `release/firefox` \u0026 `release/zip` folder.\n\n# clean:redundant\n\n\u003e Remove `generate_icons.sh` \u0026 `*.js.map` from the `release/chrome` \u0026 `release/firefox` folder.\n\n# clean:zip\n\n\u003e Remove `zip` files from the `release/chrome` \u0026 `release/firefox` folder.\n\n# build:parcel:firefox\n\n\u003e Build `backround.js` \u0026 `content.js` into the `release/firefox` folder.\n\n# build:parcel:chrome\n\n\u003e Build `backround.js` \u0026 `content.js` into the `release/chrome` folder.\n\n# copy:firefox\n\n\u003e Copy `manifest.firefox.json`, `style.firefox.css`, 'Redacted-Regular.ttf' \u0026 `icons` folder into the `release/firefox` folder.\n\n# copy:chrome\n\n\u003e Copy `manifest.chrome.json`, `style.chrome.css`, 'Redacted-Regular.ttf' \u0026 `icons` folder into the `release/chrome` folder.\n\n# rename:firefox\n\n\u003e Rename `manifest.firefox.json` to `manifest.json` in `release/firefox` folder.\n\n# rename:chrome\n\n\u003e Rename `manifest.chrome.json` to `manifest.json` in `release/chrome` folder.\n\n# zip:firefox\n\n\u003e Zip all files from `release/firefox` folder.\n\n# zip:chrome\n\n\u003e Zips all files from `release/chrome` folder.\n\n# rename:zip:firefox\n\n\u003e Rename `zip` file in `release/firefox` folder by appending `-firefox` to it.\n\n# rename:zip:chrome\n\n\u003e Rename `zip` file in `release/chrome` folder by appending `-chrome` to it.\n\n# copy:zip:firefox\n\n\u003e Copy `zip` file from `release/firefox` folder to `release/zip` folder.\n\n# copy:zip:chrome\n\n\u003e Copy `zip` file from `release/chrome` folder to `release/zip` folder.\n\n# magick\n\n\u003e Uses ImageMagick to make all images of 1280x800 resolution in `screenshots/` folder.\n\n# prod\n\n\u003e Runs `clean`, `build:parcel:*`, `copy:*`, `rename:*`, `clean:redundant`, `zip:*`, `rename:zip:*`, `copy:zip:*` \u0026 `clean:zip:*` script in order.\n\n# package:chrome\n\n\u003e Packages extension into `.crx` file for Chrome Extensions. First, generate `chrome.pem` private key manually through https://www.adambarth.com/experimental/crx/docs/packaging.html\n\n# package:firefox\n\n\u003e Packages extension into `.xpi` file for Mozilla Add-on. First, upload it to https://addons.mozilla.org/ with source-code to get it approved. For more info, see https://stackoverflow.com/a/41713280/6141587\n\nNote: To run this command you need to do the following in the terminal:\n\n```bash\n$ API_KEY=\u003cyour-api-key\u003e API_SECRET=\u003cyour-api-secret\u003e yarn package:firefox\n```\n\nIf you are using Windows, then replace `$API_KEY` by `%API_KEY%` in `package.json` to make sure it works.\n\n## Screenshots\n\n### You really gonna read this 💩shit?\n\n![Before Redact - Donald Trump on Twitter](./screenshots/before-redact.png)\n\n### Well not anymore 😂\n\n![After Redact - Donald Trump on Twitter](./screenshots/after-redact.png)\n\n## Credits\n\nThanks to [Miguel Piedrafita🛸](https://twitter.com/m1guelpf) for his [super cool implementation](https://twitter.com/deadcoder0904/status/1175015704631734272) on [Site Sauce](https://sitesauce.app/)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeadcoder0904%2Fredact-the-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeadcoder0904%2Fredact-the-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeadcoder0904%2Fredact-the-web/lists"}