Piped/README.md

142 lines
6.3 KiB
Markdown
Raw Normal View History

2020-12-18 18:55:11 +00:00
# Piped
2020-11-06 03:36:25 +00:00
2021-11-09 17:56:50 +00:00
[![AGPL v3](https://shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.en.html)
2020-12-01 13:18:24 +00:00
[![Matrix](https://img.shields.io/matrix/piped:matrix.org)](https://matrix.to/#/#piped:matrix.org)
2021-11-19 01:26:58 +00:00
[![Registered Users](https://pipedapi.kavin.rocks/registered/badge)](https://piped.kavin.rocks/register)
2022-01-28 04:32:03 +00:00
[![IPFS Build](https://github.com/TeamPiped/Piped/actions/workflows/ipfs-build.yml/badge.svg)](https://piped-ipfs.kavin.rocks/)
2020-12-01 13:18:24 +00:00
[![GitHub Repo stars](https://img.shields.io/github/stars/TeamPiped/Piped-Frontend?style=social)](https://github.com/TeamPiped/Piped/stargazers)
[![GitHub last commit](https://img.shields.io/github/last-commit/TeamPiped/Piped-Frontend)](https://github.com/TeamPiped/Piped/commits)
2021-08-26 18:54:18 +00:00
[![Translation status](https://hosted.weblate.org/widgets/piped/-/frontend/svg-badge.svg)](https://hosted.weblate.org/projects/piped/frontend/)
2020-12-01 12:34:25 +00:00
2021-11-09 17:56:50 +00:00
An open-source alternative frontend for YouTube which is efficient by design.
2020-11-17 05:15:35 +00:00
# The Problem
YouTube has an extremely invasive privacy policy which relies on using user data in unethical ways. You give them a lot of data - ranging from ideas, music taste, content, political opinions, and much more than you think.
2022-06-13 02:24:06 +00:00
By using Piped, you can freely watch and listen to content without the fear of prying eyes watching everything you are doing.
2020-12-18 18:55:11 +00:00
## Features:
2020-11-06 03:36:25 +00:00
2021-11-09 17:56:50 +00:00
**User Features**
2020-12-18 18:55:11 +00:00
- [x] No Ads
- [x] No Tracking
2021-11-09 17:56:50 +00:00
- [x] Lightweight on server and client
2020-12-18 18:55:11 +00:00
- [x] Infinite Scrolling
2021-11-09 17:56:50 +00:00
- [x] Light/Dark themes
- [x] Login
- [x] Feeds
2022-04-07 05:14:16 +00:00
- [x] Playlists
- [x] Integration with SponsorBlock
2021-11-09 17:56:50 +00:00
- [x] Integration with [LBRY](https://lbry.com/) for streaming
- [x] Integration with [Return YouTube Dislike](https://returnyoutubedislike.com/) via [RYD-Proxy](https://github.com/TeamPiped/RYD-Proxy)
2020-12-18 18:55:11 +00:00
- [x] 4K support
- [x] No connections to Google's servers
- [x] Playing just audio
- [x] PWA support
- [x] Support for iOS
2021-11-09 17:56:50 +00:00
- [x] Locally saved Preferences
- [x] [Available in many languages](src/locales), thanks to [our translators](https://hosted.weblate.org/projects/piped/frontend/)
- [x] Embedded video support
**Technical Features**
- [x] Multi-region load-balancing
2020-12-18 18:55:11 +00:00
- [x] Performant by design, designed to handle 1000s of users concurrently
2021-11-09 17:56:50 +00:00
- [x] Does not use official YouTube APIs
- [x] Uses [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor) to extract information
- [x] Public [JSON API](https://piped-docs.kavin.rocks/docs/api-documentation/)
## Screenshots
2020-11-17 05:15:35 +00:00
2021-11-09 17:56:50 +00:00
| Player | Trending | Channel |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| ![Screenshot 1](https://cloudflare-ipfs.com/ipfs/bafybeiaxhsog7jzydr7xb3xhlemxilqksceqg5fraaiuojzclhocsqrcvq) | ![Screenshot 2](https://cloudflare-ipfs.com/ipfs/bafybeigafumvrgbfyufxjptvufobstrywrfv2kteyuuictfko6kvghjszu) | ![Screenshot 3](https://cloudflare-ipfs.com/ipfs/bafybeiehs5xjqmmq34gmewxoqm3j3b2ze3pve4sdmanz7ukrxwgrcmxnry) |
2020-12-18 18:55:11 +00:00
2021-11-09 17:56:50 +00:00
## Public Chat Rooms
- You can join us via Matrix at [#piped](https://matrix.to/#/#piped:matrix.org).
- You can also join us at the libera.chat IRC network which is bridged to the Matrix room at [#piped](https://web.libera.chat/#piped).
2020-11-06 03:36:25 +00:00
## Self-Hosting
See https://piped-docs.kavin.rocks/docs/self-hosting/ for more details.
2021-11-09 17:56:50 +00:00
The source code of the documentation website is available at https://github.com/TeamPiped/Documentation.
## Documentation
2021-11-09 17:56:50 +00:00
The documentation can be found at https://piped-docs.kavin.rocks (accessible via IPNS as well).
2021-11-09 17:56:50 +00:00
## Extensions
To redirect all YouTube links to Piped, you are highly recommended to use either [Piped-Redirects](https://github.com/TeamPiped/Piped-Redirects) or [Libredirect](https://github.com/libredirect/libredirect#readme).
2021-11-09 17:56:50 +00:00
## Contributing
2021-03-29 06:38:29 +00:00
2021-11-09 17:56:50 +00:00
### Translations
2021-11-09 17:56:50 +00:00
You can help by translating the project to a language you speak at https://hosted.weblate.org/projects/piped/frontend/
2021-03-29 06:38:29 +00:00
2021-11-09 17:56:50 +00:00
### Forking, and contributing
2021-03-29 06:38:29 +00:00
2021-11-09 17:56:50 +00:00
- Fork the repository on GitHub: https://github.com/TeamPiped/Piped/fork
- Create your feature branch: `git checkout -b my-awesome-feature`
- Stage your files `git add .`
- Commit your changes `git commit -am 'Add awesome new feature'`
- Push to the branch `git push origin my-awesome-feature`
2022-06-25 05:30:35 +00:00
- Create a new pull request: https://github.com/TeamPiped/Piped/compare
2021-11-09 17:56:50 +00:00
### Development Setup
2020-11-17 05:15:35 +00:00
2020-11-06 03:36:25 +00:00
```
2020-12-24 17:05:03 +00:00
yarn install
2020-11-06 03:36:25 +00:00
```
2020-12-18 18:55:11 +00:00
### Compiles and hot-reloads for development
2020-11-17 05:15:35 +00:00
2020-11-06 03:36:25 +00:00
```
2020-12-24 17:05:03 +00:00
yarn serve
2020-11-06 03:36:25 +00:00
```
2021-11-09 17:56:50 +00:00
You can now make changes and view then in realtime!
2021-01-11 14:33:56 +00:00
2021-05-25 11:32:45 +00:00
## Contact
If you would like to contact me personally, you may do so with the following means:
- Matrix: @kavin1337:matrix.org
- Mastodon: https://mastodon.online/@kavin
- Email: kavin@kavin.rocks
2021-11-09 17:56:50 +00:00
## Donations
2021-06-21 20:12:45 +00:00
2021-11-09 17:56:50 +00:00
Donations can be made at:
- bc1qhq8zjxmu405nvp37njj6zv3s980zg400pu9jfe (BTC)
- 0x1D77D4cfB1a947514241bcf19B1F04738495e2fD (ETH)
- 8A5Up8rKgagVAz6TuUduBqHp518H1U6fYc6GqCfWsaEfjGzbSccfYpgMqp5d4oe5Ws5MuFE1iKmhQTadhMhvuk3bHRT5Ebk (XMR, aka Monero)
- nano_1ngejzydncche4rdua3iebhj7sa95pw5geq4pb8phugtjf3tku933ktjb4pq (Nano)
- XpzgouDTKCUuE8a92XqjX9b43gKL8oLihw (Dash)
2021-12-24 10:39:34 +00:00
FIAT donations can be made at: https://liberapay.com/kavin
2021-11-09 17:56:50 +00:00
Contributions in any other form are also welcomed.
2021-06-21 20:12:45 +00:00
2021-12-24 10:39:34 +00:00
# Made with Piped
- [Yattee](https://github.com/yattee/yattee) - an alternative frontend for YouTube, for IOS.
2022-01-22 15:11:57 +00:00
- [LibreTube](https://github.com/Libre-tube/LibreTube) [WIP] - an alternative frontend for YouTube, for Android.
2021-12-24 10:39:34 +00:00
2021-01-20 15:53:54 +00:00
## YourKit
2021-01-11 14:33:56 +00:00
2021-11-09 17:56:50 +00:00
![](https://www.yourkit.com/images/yklogo.png)
2021-01-11 14:33:56 +00:00
2021-01-11 14:38:17 +00:00
YourKit has given an open source license for their profiler, greatly simplifying the profiling of Piped's performance.
2021-01-11 14:33:56 +00:00
YourKit supports open source projects with its full-featured Java Profiler.
2021-11-09 17:56:50 +00:00
YourKit, LLC is the creator of [YourKit Java Profiler](https://www.yourkit.com/java/profiler/)
and [YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/),
2021-01-11 14:33:56 +00:00
innovative and intelligent tools for profiling Java and .NET applications.