condividi-link-fediverso-fi.../README.md

132 lines
5.4 KiB
Markdown
Raw Normal View History

[![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)
2022-01-14 01:13:11 +01:00
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://gitlab.com/mugcake/fedishare/pulls)
# ![img](https://gitlab.com/uploads/-/system/project/avatar/16473487/logo-min.png) Fedishare
2021-01-08 04:48:30 +01:00
2021-01-08 09:50:15 +01:00
Share the current tab on the [fediverse](https://fediverse.party/).
2021-01-08 04:48:30 +01:00
2021-08-21 05:54:46 +02:00
## Get the extension
2021-08-21 05:54:46 +02:00
| Firefox Add-ons | Trisquel Add-ons |
---|---
2021-08-21 05:54:46 +02:00
[![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)](https://trisquel.info/en/browser/addons/fedishare)
2021-01-08 09:01:57 +01:00
## Features
2021-01-08 16:41:56 +01:00
Simplest add-on for the fediverse. Share web pages right from the toolbar button.
### Supported services/protocols:
- [ ] [Bonfire](https://bonfirenetworks.org/)
2022-01-14 01:13:11 +01:00
- [x] [Diaspora](https://diasporafoundation.org/)
- [x] [Ecko](https://magicstone.dev/) (Mastodon button)
- [ ] [Epicyon](https://epicyon.net/)
- [ ] [Flockingbird](https://flockingbird.social/)
2022-01-14 01:13:11 +01:00
- [x] [Friendica](https://friendi.ca/)
- [x] [Glitch](https://glitch-soc.github.io/docs/) (Mastodon button)
2022-01-14 01:13:11 +01:00
- [x] [Gnusocial](https://gnusocial.network/)
- [x] [GoToSocial](https://docs.gotosocial.org/en/latest/) (Mastodon button)
- [x] [Groundpolis](https://github.com/Groundpolis/Groundpolis) (Mastodon button)
- [x] [Hometown](https://github.com/hometown-fork/hometown) (Mastodon button)
- [ ] [Honk](https://humungus.tedunangst.com/r/honk)
2022-01-14 01:13:11 +01:00
- [x] [Hubzilla](https://hubzilla.org/)
- [x] [Kepi](https://gitlab.com/marnanel/chapeau) (Mastodon button)
- [ ] [Ktistec](https://github.com/toddsundsted/ktistec)
2022-01-14 01:13:11 +01:00
- [x] [Lemmy](https://join-lemmy.org/)
- [x] [Mastodon](https://joinmastodon.org/)
- [x] [Misskey](https://misskey-hub.net/en/) (Mastodon button)
- [x] [Misty](https://zotlabs.com/misty/) (Hubzilla button)
- [ ] [Mobilizon](https://joinmobilizon.org/en/)
- [ ] [NextCloud](https://nextcloud.com/)
2022-01-14 01:13:11 +01:00
- [x] [Osada](https://codeberg.org/zot/osada) (Hubzilla button)
- [ ] [Pjuu](https://pjuu.com/) *1
- [x] [Pleroma](https://pleroma.social/)
- [ ] [Pump.io](http://pump.io/) *2
- [ ] [Smithereen](https://github.com/grishka/Smithereen)
2022-01-14 01:13:11 +01:00
- [x] [Socialhome](https://socialhome.network/)
- [x] [XMPP](https://xmpp.org/)
- [x] [Zap](https://zotlabs.com/zap/) (Hubzilla button)
- *1 It doesn't have a public API
- *2 Conflicts with the [API](https://github.com/pump-io/pump.io/blob/master/API.md)
2021-01-08 09:01:57 +01:00
## Contributing
You can contribute in the following ways:
- Finding and reporting bugs.
- Contributing code to the project by fixing bugs or implementing features.
2021-01-08 09:01:57 +01:00
### Bug reports
Bug reports and feature suggestions can be submitted to [Gitlab Issues](https://gitlab.com/mugcake/fedishare/issues). Please make sure that you are not submitting duplicates, and that a similar report or request has not already been resolved or rejected in the past using the search function. Please also use descriptive, concise titles.
2021-01-08 09:01:57 +01:00
### Pull request
Please use clean, concise titles for your pull requests.
## Build
2021-01-08 09:01:57 +01:00
This project uses the [Web Extension Boilerplate](https://github.com/davidnguyen179/web-extension-boilerplate).
2021-01-08 09:01:57 +01:00
### Prerequisites
2021-01-08 16:41:56 +01:00
2022-01-14 01:13:11 +01:00
- Mozilla-based browser: 59 (or higher)
2021-01-08 16:41:56 +01:00
**Install all dependencies:** `npm i`
2021-01-08 16:41:56 +01:00
### Development
2021-01-08 09:01:57 +01:00
2022-01-14 01:13:11 +01:00
- Dev: `npm run app:dev`
- Production: `npm run app:dist`
2021-08-18 06:57:59 +02:00
#### Load package to browsers
2021-08-18 06:57:59 +02:00
1. Go to the browser's URL address bar
2. Enter `about:debugging#/runtime/this-firefox`
2022-01-14 01:13:11 +01:00
3. Click **Load Temporary Add-on...**
4. Browse to your `manifest.json` & click **Open**
2021-08-18 06:57:59 +02:00
#### CSS
2021-08-18 06:57:59 +02:00
[tailwindcss](https://tailwindcss.com) is the framework used for this project.
2021-08-18 06:57:59 +02:00
- Dev: `npm run style-dev`
2022-01-14 01:13:11 +01:00
- Production: `npm run style-dist`
2021-08-18 06:57:59 +02:00
Set all css custom in: `public/styles.css`. The `main.css` is generated in `dist`.
2021-08-18 06:57:59 +02:00
## Donations
2021-08-18 06:57:59 +02:00
2022-01-14 01:13:11 +01:00
If you like the stuff I make and are financially able please consider donating. Your support allows me to dedicate more time to this and other FOSS projects :D
2021-08-18 06:57:59 +02:00
2021-08-21 05:54:46 +02:00
<a href='https://ko-fi.com/mugcake' target='_blank'><img height='35' style='border:0px;height:46px;' src='https://uploads-ssl.webflow.com/5c14e387dab576fe667689cf/5cbed8a433a3f45a772abaf5_SupportMe_blue-p-500.png' border='0' alt='Buy Me a Coffee at ko-fi.com' />
2021-08-18 06:57:59 +02:00
2021-08-21 06:25:52 +02:00
[![img](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/mickie/)
2022-01-14 01:13:11 +01:00
__Bitcoin BTC:__ TODO
2021-08-21 05:54:46 +02:00
2022-01-14 01:13:11 +01:00
__Ethereum ETH:__ TODO
2021-08-18 06:57:59 +02:00
## License
2021-08-18 06:57:59 +02:00
[![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)
2021-08-18 06:57:59 +02:00
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/>.
2021-08-18 06:57:59 +02:00