Remove contributors, fix README and jest.config.js
This commit is contained in:
mickie
parent
3685e8696b
commit
e02207d005
|
|
@ -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
|
|
||||||
}
|
|
||||||
226
README.md
226
README.md
|
|
@ -1,32 +1,48 @@
|
||||||
#  Share Freedom - browser extension
|
[](https://github.com/facebook/jest)
|
||||||
|
[](https://github.com/prettier/prettier)
|
||||||
|
[](https://github.com/davidnguyen179/web-extension-boilerplate/pulls)
|
||||||
|
|
||||||
|
|
||||||
|
#  Fedishare
|
||||||
|
|
||||||
Share the current tab on the [fediverse](https://fediverse.party/).
|
Share the current tab on the [fediverse](https://fediverse.party/).
|
||||||
|
|
||||||
[](https://addons.mozilla.org/en-US/firefox/addon/share-freedom/)
|
## Get the extension TODO
|
||||||
|
|
||||||
|
### Gecko
|
||||||
|
|
||||||
|
| Firefox Browser Add-ons | Trisquel Web Browser Add-ons |
|
||||||
|
---|---
|
||||||
|
[](https://addons.mozilla.org/en-US/firefox/addon/fedishare-addon) | 
|
||||||
|
|
||||||
|
### Blink
|
||||||
|
|
||||||
|
| Chrome Web Store | Opera addons |
|
||||||
|
---|---
|
||||||
|
 | 
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
Simplest add-on for the fediverse. Share web pages right from the toolbar button.
|
Simplest add-on for the fediverse. Share web pages right from the toolbar button.
|
||||||
|
|
||||||
Supported services/protocols:
|
### Supported services/protocols:
|
||||||
- Gnusocial
|
|
||||||
- Mastodon / Misskey
|
|
||||||
- Hubzilla
|
|
||||||
- Diaspora
|
- Diaspora
|
||||||
- Friendica
|
- Friendica
|
||||||
- Socialhome
|
- Gnusocial
|
||||||
|
- Hubzilla / Zap
|
||||||
- Lemmy
|
- Lemmy
|
||||||
|
- Mastodon / Misskey
|
||||||
- Pleroma
|
- Pleroma
|
||||||
- Osada / Zap / Zot6
|
- Socialhome
|
||||||
- XMPP
|
- XMPP
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
You can contribute in the following ways:
|
You can contribute in the following ways:
|
||||||
|
|
||||||
- Finding and reporting bugs
|
- Finding and reporting bugs.
|
||||||
- Contributing code to the project by fixing bugs or implementing features
|
- Contributing code to the project by fixing bugs or implementing features.
|
||||||
|
|
||||||
|
|
||||||
### Bug reports
|
### 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.
|
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
|
__Bitcoins:__ bc1qf7v8zty2yz8phulet29wcpxjclvffn5w6ry43w
|
||||||
|
|
||||||
__Ethereum:__ 0xca2FD9C3834694E2cB3db3bf79b3AfB083bA6732
|
__Ethereum:__ 0xca2FD9C3834694E2cB3db3bf79b3AfB083bA6732
|
||||||
|
|
||||||
|
|
||||||
[CC-BY 4.0 by Vincent Le Moign](https://commons.wikimedia.org/wiki/File:552-soft-ice-cream-2.svg)
|
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This program is licensed under GPL v3
|
[](http://www.gnu.org/licenses/gpl-3.0.en.html)
|
||||||
|
|
||||||
Copyleft (ɔ) 2021 - Miguel (mickie)
|
Copyright (C) 2019-2021 Miguel (aka mickie) <millet@tuta.io>
|
||||||
|
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 <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
See LICENSE file for more information.
|
|
||||||
|
|
||||||
## TODO
|
|
||||||
This boilerplate provides a skeleton to start developing cross-browser web extensions.
|
|
||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
||||||
[](#contributors-)
|
|
||||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
|
||||||
|
|
||||||
[](https://github.com/facebook/jest) [](https://github.com/prettier/prettier) [](https://github.com/davidnguyen179/web-extension-boilerplate/pulls)
|
|
||||||
|
|
||||||
|
|
||||||
## 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)):
|
|
||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
||||||
<!-- prettier-ignore-start -->
|
|
||||||
<!-- markdownlint-disable -->
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td align="center"><a href="https://www.dzungnguyen.dev"><img src="https://avatars.githubusercontent.com/u/6290720?v=4?s=100" width="100px;" alt=""/><br /><sub><b>David Nguyen</b></sub></a><br /><a href="https://github.com/davidnguyen179/web-extension-boilerplate/commits?author=davidnguyen179" title="Code">💻</a> <a href="https://github.com/davidnguyen179/web-extension-boilerplate/commits?author=davidnguyen179" title="Documentation">📖</a> <a href="#design-davidnguyen179" title="Design">🎨</a> <a href="#maintenance-davidnguyen179" title="Maintenance">🚧</a> <a href="https://github.com/davidnguyen179/web-extension-boilerplate/pulls?q=is%3Apr+reviewed-by%3Adavidnguyen179" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/davidnguyen179/web-extension-boilerplate/commits?author=davidnguyen179" title="Tests">⚠️</a></td>
|
|
||||||
<td align="center"><a href="https://github.com/immint023"><img src="https://avatars.githubusercontent.com/u/38607460?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Minh Ngo</b></sub></a><br /><a href="https://github.com/davidnguyen179/web-extension-boilerplate/commits?author=immint023" title="Code">💻</a> <a href="https://github.com/davidnguyen179/web-extension-boilerplate/commits?author=immint023" title="Tests">⚠️</a></td>
|
|
||||||
<td align="center"><a href="http://benlee3.com"><img src="https://avatars.githubusercontent.com/u/35267414?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ben Harned</b></sub></a><br /><a href="https://github.com/davidnguyen179/web-extension-boilerplate/commits?author=3BenLee" title="Documentation">📖</a></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<!-- markdownlint-restore -->
|
|
||||||
<!-- prettier-ignore-end -->
|
|
||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
||||||
|
|
||||||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
const ignores = ['/node_modules/', '__mocks__'];
|
const ignores = ['/node_modules/', '__mocks__'];
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
collectCoverageFrom: ['src/lib/app.ts', 'src/lib/utils.ts'],
|
collectCoverageFrom: ['src/lib/app.ts'],
|
||||||
testMatch: ['**/test/**/*.spec.+(ts|tsx|js)'],
|
testMatch: ['**/test/**/*.spec.+(ts|tsx|js)'],
|
||||||
testPathIgnorePatterns: [...ignores],
|
testPathIgnorePatterns: [...ignores],
|
||||||
coveragePathIgnorePatterns: [...ignores, 'src/(umd|cjs|esm)-entry.js$'],
|
coveragePathIgnorePatterns: [...ignores, 'src/(umd|cjs|esm)-entry.js$'],
|
||||||
|
|
|
||||||
|
|
@ -15,8 +15,8 @@
|
||||||
"app:firefox": "rimraf dist && cross-env BROWSER='firefox' webpack --config webpack/webpack.prod.js",
|
"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",
|
"app:firefox-dev": "cross-env BROWSER='firefox' webpack --config webpack/webpack.dev.js --watch",
|
||||||
"test:unit": "jest",
|
"test:unit": "jest",
|
||||||
"build:css": "postcss ./public/css/styles.css -o ./dist/css/main.css",
|
"style-dev": "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": "NODE_ENV=production postcss ./public/css/styles.css -o ./dist/css/main.css"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue