From e02207d0051646d9bf820bdf0335c95a9b69b8fe Mon Sep 17 00:00:00 2001 From: mickie Date: Fri, 20 Aug 2021 18:39:54 -0500 Subject: [PATCH] Remove contributors, fix README and jest.config.js --- .all-contributorsrc | 48 ---------- README.md | 226 +++++++++++++++++++------------------------- jest.config.js | 2 +- package.json | 4 +- 4 files changed, 101 insertions(+), 179 deletions(-) delete mode 100644 .all-contributorsrc diff --git a/.all-contributorsrc b/.all-contributorsrc deleted file mode 100644 index 5cf0132..0000000 --- a/.all-contributorsrc +++ /dev/null @@ -1,48 +0,0 @@ -{ - "files": [ - "README.md" - ], - "imageSize": 100, - "commit": false, - "contributors": [ - { - "login": "davidnguyen179", - "name": "David Nguyen", - "avatar_url": "https://avatars.githubusercontent.com/u/6290720?v=4", - "profile": "https://www.dzungnguyen.dev", - "contributions": [ - "code", - "doc", - "design", - "maintenance", - "review", - "test" - ] - }, - { - "login": "immint023", - "name": "Minh Ngo", - "avatar_url": "https://avatars.githubusercontent.com/u/38607460?v=4", - "profile": "https://github.com/immint023", - "contributions": [ - "code", - "test" - ] - }, - { - "login": "3BenLee", - "name": "Ben Harned", - "avatar_url": "https://avatars.githubusercontent.com/u/35267414?v=4", - "profile": "http://benlee3.com", - "contributions": [ - "doc" - ] - } - ], - "contributorsPerLine": 7, - "projectName": "web-extension-boilerplate", - "projectOwner": "davidnguyen179", - "repoType": "github", - "repoHost": "https://github.com", - "skipCi": true -} diff --git a/README.md b/README.md index f7b62d3..74c970d 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,48 @@ -# ![img](/src/img/logo.png) Share Freedom - browser extension +[![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest) +[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/davidnguyen179/web-extension-boilerplate/pulls) +![ci/cd](https://github.com/davidnguyen179/web-extension-boilerplate/workflows/ci/cd/badge.svg) + +# ![img](https://gitlab.com/uploads/-/system/project/avatar/16473487/logo-min.png) Fedishare Share the current tab on the [fediverse](https://fediverse.party/). -[![Firefox Add-on](/src/img/badge-amo.png)](https://addons.mozilla.org/en-US/firefox/addon/share-freedom/) +## Get the extension TODO +### Gecko + +| Firefox Browser Add-ons | Trisquel Web Browser Add-ons | +---|--- +[![img](https://upload.wikimedia.org/wikipedia/commons/thumb/a/a0/Firefox_logo%2C_2019.svg/77px-Firefox_logo%2C_2019.svg.png)](https://addons.mozilla.org/en-US/firefox/addon/fedishare-addon) | ![img](https://trisquel.info/files/avatars/picture-1.png) + +### Blink + +| Chrome Web Store | Opera addons | +---|--- +![img](https://storage.googleapis.com/chrome-gcs-uploader.appspot.com/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/tbyBjqi7Zu733AAKA5n4.png) | ![img](https://addons-static.operacdn.com/static/header-footer/css/img/opera-addons.png) ## Features Simplest add-on for the fediverse. Share web pages right from the toolbar button. -Supported services/protocols: -- Gnusocial -- Mastodon / Misskey -- Hubzilla +### Supported services/protocols: + - Diaspora - Friendica -- Socialhome +- Gnusocial +- Hubzilla / Zap - Lemmy +- Mastodon / Misskey - Pleroma -- Osada / Zap / Zot6 +- Socialhome - XMPP ## Contributing You can contribute in the following ways: -- Finding and reporting bugs -- Contributing code to the project by fixing bugs or implementing features +- Finding and reporting bugs. +- Contributing code to the project by fixing bugs or implementing features. ### Bug reports @@ -38,133 +54,87 @@ Bug reports and feature suggestions can be submitted to [Gitlab Issues](https:// Please use clean, concise titles for your pull requests. +## Build -## Invite an ice cream +This project uses the [Web Extension Boilerplate](https://github.com/davidnguyen179/web-extension-boilerplate). + +### Prerequisites + +Gecko +- Mozilla Firefox 59 (or higher) + +**Install all dependencies:** `npm i` + +### Development + +##### Chrome + +- Dev: `npm run app:chrome-dev` +- Production: `npm run app:chrome` + +##### Edge + +- Dev: `npm run app:edge-dev` +- Production: `npm run app:edge` + +##### Firefox + +- Dev: `npm run app:firefox-dev` +- Production: `npm run app:firefox` + +#### Load package to browsers + +1. Go to the browser's URL address bar + +In Chrome: +2. Enter `chrome://extensions` + +In Edge: +2. Enter `edge://extensions` + +In Firefox: +2. Enter `about:debugging#/runtime/this-firefox` + +In Chrome and Edge: + 3. Turn on "**Developer mode**" + 4. Load extension by clicking "**Load unpacked**" + 5. Browse to `dist/` in source code. + +In Firefox: + 3. Click **Load Temporary Add-on...** + 4. Browse to your `manifest.json` & click **Open** + +#### CSS + +[tailwindcss](https://tailwindcss.com) is the framework used for this project. + +- Dev: `npm run style-dev` +- Production: `npm run style` + +Set all css custom in: `public/styles.css`. The `main.css` is generated in `dist`. + +## Donations -You can collaborate with __donations__ for the project :) __Bitcoins:__ bc1qf7v8zty2yz8phulet29wcpxjclvffn5w6ry43w __Ethereum:__ 0xca2FD9C3834694E2cB3db3bf79b3AfB083bA6732 -![](/src/img/ice-cream.png) -[CC-BY 4.0 by Vincent Le Moign](https://commons.wikimedia.org/wiki/File:552-soft-ice-cream-2.svg) - - ## License -This program is licensed under GPL v3 +[![Large GPLv3 logo with โ€œFree as in Freedomโ€](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](http://www.gnu.org/licenses/gpl-3.0.en.html) -Copyleft (ษ”) 2021 - Miguel (mickie) + Copyright (C) 2019-2021 Miguel (aka mickie) + This file is part of Fedishare. + Fedishare is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + You should have received a copy of the GNU General Public License + along with this program. If not, see . -See LICENSE file for more information. -## TODO -This boilerplate provides a skeleton to start developing cross-browser web extensions. - - -[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-) - - -[![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/davidnguyen179/web-extension-boilerplate/pulls) -![ci/cd](https://github.com/davidnguyen179/web-extension-boilerplate/workflows/ci/cd/badge.svg) - -## Development - -```bash -npm i -``` - -**Chrome** - -```bash -npm run app:chrome-dev -``` - -**Edge** - -```bash -npm run app:edge-dev -``` - -**Firefox** - -```bash -npm run app:firefox-dev -``` - -## Production - -```bash -npm i -``` - -```bash -npm run app:chrome -``` - -**Edge** - -```bash -npm run app:edge -``` - -**Firefox** - -```bash -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](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/](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/) - -## Contributors โœจ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - -

David Nguyen
๐Ÿ’ป ๐Ÿ“– ๐ŸŽจ ๐Ÿšง ๐Ÿ‘€ โš ๏ธ
Minh Ngo
๐Ÿ’ป โš ๏ธ
Ben Harned
๐Ÿ“–
- - - - - - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/jest.config.js b/jest.config.js index ca0ac9c..c6c0284 100644 --- a/jest.config.js +++ b/jest.config.js @@ -1,7 +1,7 @@ const ignores = ['/node_modules/', '__mocks__']; module.exports = { - collectCoverageFrom: ['src/lib/app.ts', 'src/lib/utils.ts'], + collectCoverageFrom: ['src/lib/app.ts'], testMatch: ['**/test/**/*.spec.+(ts|tsx|js)'], testPathIgnorePatterns: [...ignores], coveragePathIgnorePatterns: [...ignores, 'src/(umd|cjs|esm)-entry.js$'], diff --git a/package.json b/package.json index 4e78f50..bbfe5da 100644 --- a/package.json +++ b/package.json @@ -15,8 +15,8 @@ "app:firefox": "rimraf dist && cross-env BROWSER='firefox' webpack --config webpack/webpack.prod.js", "app:firefox-dev": "cross-env BROWSER='firefox' webpack --config webpack/webpack.dev.js --watch", "test:unit": "jest", - "build:css": "postcss ./public/css/styles.css -o ./dist/css/main.css", - "build": "NODE_ENV=production postcss ./public/css/styles.css -o ./dist/css/main.css" + "style-dev": "postcss ./public/css/styles.css -o ./dist/css/main.css", + "style": "NODE_ENV=production postcss ./public/css/styles.css -o ./dist/css/main.css" }, "repository": { "type": "git",