https://github.com/axel-dev/youtube-viewer
:tv: YouTube channels tracking made easy
https://github.com/axel-dev/youtube-viewer
favorite-youtube-channels react webextension youtube youtube-channels youtube-viewer
Last synced: 4 months ago
JSON representation
:tv: YouTube channels tracking made easy
- Host: GitHub
- URL: https://github.com/axel-dev/youtube-viewer
- Owner: AXeL-dev
- License: mpl-2.0
- Created: 2020-01-23T22:26:38.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-11T00:22:08.000Z (almost 3 years ago)
- Last Synced: 2023-03-07T06:37:52.253Z (almost 3 years ago)
- Topics: favorite-youtube-channels, react, webextension, youtube, youtube-channels, youtube-viewer
- Language: TypeScript
- Homepage: https://axel-dev.github.io/youtube-viewer/
- Size: 27.4 MB
- Stars: 19
- Watchers: 5
- Forks: 6
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 
YouTube viewer
[](https://addons.mozilla.org/firefox/addon/yt-viewer/?src=external-github-shield-downloads)
[](https://addons.mozilla.org/firefox/addon/yt-viewer/?src=external-github-shield-downloads)
[](https://addons.mozilla.org/firefox/addon/yt-viewer/statistics/)
[](https://addons.mozilla.org/firefox/addon/yt-viewer/reviews/)
[](https://www.paypal.me/axeldev)
A web extension to keep tracking your favorite youtube channels with less hassle.
## Motivation
This is a fun made project with one simple goal: Discover & practice [React](https://reactjs.org/). Any help or feedback is welcome :pray:.
## Features
- Track multi channels all in one place
- Get notifications about new posted videos (no need to have a google account)
- Save videos to watch later
- Auto play videos on click
- Export/import channels list
- Light/Dark mode
- (Soon) Open videos in [PiP](https://support.mozilla.org/en-US/kb/about-picture-picture-firefox) mode
## Installation
[](https://addons.mozilla.org/firefox/addon/yt-viewer/?src=external-github-download)
[](https://microsoftedge.microsoft.com/addons/detail/youtube-viewer/goajjkolaajaenalckacknjmadkfnngp)
[](https://chrome.google.com/webstore/detail/youtube-viewer/lmcpajkgakbmgbjfmgomhpmmpfaadpdp)
Or [try it as a web application](https://axel-dev.github.io/youtube-viewer/).
[How to install?](https://github.com/AXeL-dev/install-webextension)
## Todo
- [x] Notifications for new posted videos (with auto-check every x minutes)
- [x] Improve caching (videos cache could be saved in the storage which may reduce API quota consumption)
- [x] Better state management
- [x] Option to auto-play videos once opened
- [ ] Option to open videos directly in [Picture-in-Picture](https://w3c.github.io/picture-in-picture/) mode
- [ ] Translations
- [ ] Unit tests
## Technical
### Stack
- [React](https://reactjs.org/): Core library
- [Material-UI](https://mui.com/): UI toolkit
- [dnd-kit](https://dndkit.com/): Drag and drop library
- [redux](https://redux.js.org/): State management library
- [react-youtube](https://github.com/tjallingt/react-youtube): YouTube player component
### Scripts
In the project directory, you can run:
#### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.
#### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
#### `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
#### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
#### `npm run package`
**Note: the web-ext package is required. You can install it using `npm install -g web-ext`.**
Packages the app in a zip file.
## Setup your own Youtube API key
Open the `.env` file in the root directory of the project & put inside your API key like so:
```
REACT_APP_YOUTUBE_API_KEY=replace_this_with_your_api_key
```
Save, then start or build the app.
## Credits
Icon made by [Vectorgraphit](https://www.iconfinder.com/vectorgraphit) and is licensed under [Creative Commons Attribution 3.0 Unported License](https://creativecommons.org/licenses/by/3.0/).
## License
This project is licensed under the [MPL2](LICENSE) license.