poke/README.md

110 lines
4.6 KiB
Markdown
Raw Normal View History

2023-08-04 23:28:25 +02:00
<h1 align="center">
2022-12-24 13:59:34 +01:00
<a href="https://poketube.fun/watch?v=9sJUDx7iEJw&quality=medium&=sjohgteojgytrueugtye4jhtytjrjnyıı">
2024-06-21 22:57:15 +02:00
<img src="https://poketube.fun/css/logo-poke.svg" width="400">
</a>
<a href="http://www.defectivebydesign.org/drm-free">
<img src="https://static.fsf.org/dbd/label/DRM-free%20label%20120.en.png"
alt="DRM Free" width="65" height="65" border="0" align="middle" />
</a>
<p>PRIVACY APP OF YOUR DREAMS! :3</p>
</h1>
2024-01-18 07:16:18 +01:00
2023-10-28 14:13:56 +02:00
<div align="center">
2024-06-21 22:57:15 +02:00
<p>Be anonymous while watching (cat falling) videos, searching the web, and listening to music on Poke - the free privacy front-end!</p>
</div>
2023-10-28 14:13:56 +02:00
2024-06-21 22:57:15 +02:00
<div align="center">
<a href="#welcome">Welcome!</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="#features">Features</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="#no-non-free-codec-needed">No Non-Free Codec</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="#hosting-poke">Hosting</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="#poke-community">Community</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="#legal">Legal</a>
<br><br>
<a href="https://status.poketube.fun" target="_blank">
<img width="170" src="https://api.netweak.com/status-badges/K2LY9" alt="Status Badge"/>
</a>
<img src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg" alt="Stand with Ukraine">
<a href="./LICENSE">
<img src="https://img.shields.io/badge/License-GPL--3-FF6666" alt="GPL-3 License">
</a>
2023-08-04 23:28:25 +02:00
</div>
2024-05-01 05:07:06 +02:00
![Preview](./css/README_Preview.png)
2023-08-04 23:28:25 +02:00
## Welcome!
2024-06-21 22:57:15 +02:00
Welcome to Poke (formerly PokeTube), the privacy-friendly YouTube front-end built with the InnerTube API! Imagine paying for YouTube Premium just to download videos - couldn't be us (literally).
2023-10-28 10:57:28 +02:00
2024-06-21 22:57:15 +02:00
## Features
2023-10-28 10:57:28 +02:00
2024-06-21 22:57:15 +02:00
| <img width="100%" style="border-radius: 24px" src="./css/README_RYD.png"> | <div style="text-align: left"><h3>🔙 Built-In Return YouTube Dislikes</h3>See the dislikes from *returnyoutubedislike* - because sometimes you need to know how bad that video really is :3</div> |
2024-05-01 05:07:06 +02:00
| - | - |
2024-06-21 22:57:15 +02:00
| <div style="text-align: right"><h3>📱 PWA Support</h3>With PWA Support, you can install Poke on your mobile device. Now you can pretend to be productive while watching cat videos on the go, mreoww! :3</div> | <img width="100%" style="border-radius: 24px" src="./css/README_PWA.jpg"> |
| <h3>🎨 Customize</h3>Customize Poke however you want. Make it as unique as your taste in memes. | <h3>📥 Accounts</h3>Suscribe (yes Suscribe hehe sussy baka) to whaever channel you want! </div> |
| <h3>🔍 Web Search</h3>Search the web privately on PokeTube. Incognito mode who? | <h3>🎶 And...</h3>Ambient mode, HQ audio, and even more! :3 |
2023-03-07 20:57:11 +01:00
2024-06-21 22:57:15 +02:00
## No Non-Free Codec Needed
2024-02-16 18:00:55 +01:00
2024-06-21 22:57:15 +02:00
Poke uses OpenH264, which is free software! No non-free components included :3 View the source code of OpenH264 [here](https://github.com/cisco/openh264.git). Because who wants to deal with non-free stuff? Not us!~
2024-02-16 18:00:55 +01:00
2024-06-21 22:57:15 +02:00
## Hosting Poke
2024-06-21 22:57:15 +02:00
### NodeJS
2022-08-09 11:39:18 +02:00
2024-06-21 22:57:15 +02:00
1. **Install Packages**
- Fedora/RHEL: `$ sudo dnf install git make gcc libcurl nodejs python libcurl4 g++`
- Debian/Ubuntu: `$ sudo apt install git make gcc libcurl4-openssl-dev nodejs npm python g++`
2024-05-01 05:07:06 +02:00
2024-06-21 22:57:15 +02:00
2. **Clone Repo**
- Codeberg: `$ git clone https://codeberg.org/ashley/poke.git`
- GitHub: `$ git clone https://github.com/ashley0143/poke.git`
2024-05-01 05:07:06 +02:00
2024-06-21 22:57:15 +02:00
3. **Install Dependencies**
- `$ cd poke`
- `$ npm install`
2023-08-04 23:28:25 +02:00
2024-06-21 22:57:15 +02:00
4. **Start Server**
- `$ node server.js`
2023-08-04 23:28:25 +02:00
2024-06-21 22:57:15 +02:00
Congrats! PokeTube should now be running on `localhost:6003`! 🎉
2024-05-01 05:07:06 +02:00
2024-06-21 22:57:15 +02:00
### Docker
2024-05-01 05:07:06 +02:00
2024-06-21 22:57:15 +02:00
1. **Create Directory**
- `$ mkdir poketube && cd poketube`
2023-08-04 23:28:25 +02:00
2024-06-21 22:57:15 +02:00
2. **Download Config**
- `$ curl -O https://codeberg.org/Ashley/poke/raw/branch/main/docker-compose.yml`
2024-06-21 22:57:15 +02:00
3. **Run PokeTube**
- `$ docker compose up -d`
2023-08-04 23:28:25 +02:00
2024-06-21 22:57:15 +02:00
Congrats! PokeTube should now be running on `localhost:6003`! 🎉
2023-11-30 12:05:12 +01:00
2024-06-21 22:57:15 +02:00
## Poke Community
2024-05-01 05:07:06 +02:00
2024-08-03 20:54:41 +02:00
Join us on [Discord](https://discord.poketube.fun/) or [Matrix](https://matrix.to/#/#poke:vern.cc)! I promise we're cool! <3
2023-08-04 23:28:25 +02:00
2024-06-21 22:57:15 +02:00
## The Legal Stuff (boring tbh)
2023-12-30 20:04:33 +01:00
the main parts of the project is Under GPL-3.0-OR-LATER :3
see the each sections LICENSE tho!!
Copyleft 2021-202x Poke Project
[Code Of conduct](https://codeberg.org/Ashley/poke/src/branch/main/CODE_OF_CONDUCT.md)
2023-03-07 20:57:11 +01:00
2023-08-04 23:28:25 +02:00
[Privacy Policy](https://poketube.fun/privacy)
2022-08-25 13:40:24 +02:00
2023-08-04 23:28:25 +02:00
TL;DR: we dont collect or share your personal info, that's it lol.
2024-06-21 22:57:15 +02:00
We use the GNU Coding Standard Thingy, see [this link.](https://www.gnu.org/prep/standards)
2023-10-07 11:35:32 +02:00
2023-10-17 17:33:09 +02:00
2024-06-21 22:57:15 +02:00
<div align="center">
<p>Parts of Poke are hosted on Glitch.com since <i>2020</i>.</p>
<a href="https://glitch.com/">
<img src="https://cdn.glitch.global/d68d17bb-f2c0-4bc3-993f-50902734f652/glitch-fastly-lock-up.svg">
</a>
<br><hr>
<a href="https://gnu.org/not-open-source">
<img width="200" src="https://autumn.revolt.chat/attachments/eNpfwV2C1_wudONe43YCvWr-4vbvLpG78HbuXgOYfO">
</a>
</div>