Piped/README.md

91 lines
3.0 KiB
Markdown
Raw Normal View History

2020-12-18 18:55:11 +00:00
# Piped
2020-11-06 03:36:25 +00:00
2020-12-01 13:18:24 +00:00
[![Matrix](https://img.shields.io/matrix/piped:matrix.org)](https://matrix.to/#/#piped:matrix.org)
2021-04-01 15:19:54 +00:00
[![IPFS Build](https://github.com/TeamPiped/Piped/actions/workflows/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)
2020-12-01 12:34:25 +00:00
2020-12-18 18:55:11 +00:00
An alternative YouTube frontend 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.
By using Piped, you can freely watch and listen to content freely 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
2020-12-18 18:55:11 +00:00
- [x] No Ads
- [x] No Tracking
- [x] Infinite Scrolling
- [x] Integration with SponsorBlock
- [x] Integration with LBRY
2020-12-18 18:55:11 +00:00
- [x] 4K support
- [x] No connections to Google's servers
- [x] Playing just audio
2021-06-16 19:13:18 +00:00
- [x] Comments
- [x] Playlist support
- [x] Captions support
- [x] Search Suggestions
2021-01-20 15:53:54 +00:00
- [x] Livestreams support with a quality selector
2020-12-18 18:55:11 +00:00
- [x] PWA support
- [x] Preferences saved locally
- [x] Multi-region loadbalancing
- [x] Performant by design, designed to handle 1000s of users concurrently
2020-11-17 05:15:35 +00:00
2020-12-18 18:55:11 +00:00
## WIP
- [ ] Login
- [ ] Feeds
- [ ] 8K support
2021-03-08 22:18:52 +00:00
- [ ] Improving UI
2020-11-06 03:36:25 +00:00
## Documentation
The documentation can be found at https://piped-docs.kavin.rocks (accessible via IPNS as well)
## Screenshots
![Screenshot 1](https://cloudflare-ipfs.com/ipfs/bafybeigafumvrgbfyufxjptvufobstrywrfv2kteyuuictfko6kvghjszu)
![Screenshot 2](https://cloudflare-ipfs.com/ipfs/bafybeiaxhsog7jzydr7xb3xhlemxilqksceqg5fraaiuojzclhocsqrcvq)
![Screenshot 3](https://cloudflare-ipfs.com/ipfs/bafybeiehs5xjqmmq34gmewxoqm3j3b2ze3pve4sdmanz7ukrxwgrcmxnry)
2021-03-29 06:38:29 +00:00
## Donations
Donations can be made at 13MoHioctZkC7LDSZSb4m32TDT8xNmei1p (BTC)
Contributions in any other form are also welcomed.
2020-12-18 18:55:11 +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
```
2020-12-18 18:55:11 +00:00
You can now make changes and see them as soon you save the file!
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-01-20 15:53:54 +00:00
## YourKit
2021-01-11 14:33:56 +00:00
2021-05-28 12:13:25 +00:00
<img src="https://www.yourkit.com/images/yklogo.png"></img>
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-05-28 12:13:25 +00:00
YourKit, LLC is the creator of <a href="https://www.yourkit.com/java/profiler/">YourKit Java Profiler</a>
and <a href="https://www.yourkit.com/.net/profiler/">YourKit .NET Profiler</a>,
2021-01-11 14:33:56 +00:00
innovative and intelligent tools for profiling Java and .NET applications.