Piped/README.md

60 lines
1.9 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)
2020-12-01 12:34:25 +00:00
![Netlify](https://img.shields.io/netlify/6ccde6a7-6792-4105-9a28-ee13ce1fbc44)
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
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-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
- [ ] Proper video support Blocked by NPE[#461](https://github.com/TeamNewPipe/NewPipeExtractor/issues/461)
- [ ] Login
- [ ] Comments
- [ ] Feeds
- [ ] 8K support
- [ ] Custom extractor for streams?
- [ ] Video Muxing
2020-11-06 03:36:25 +00:00
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-01-20 15:53:54 +00:00
## YourKit
2021-01-11 14:33:56 +00:00
<img src="http://www.yourkit.com/images/yklogo.png"></img>
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.
YourKit, LLC is the creator of <a href="http://www.yourkit.com/java/profiler/index.jsp">YourKit Java Profiler</a>
and <a href="http://www.yourkit.com/.net/profiler/index.jsp">YourKit .NET Profiler</a>,
innovative and intelligent tools for profiling Java and .NET applications.