poke/README.md
2025-10-08 15:58:23 +02:00

119 lines
5.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<h1 align="center">
<a href="https://poketube.fun/watch?v=QZfH7cFp3Ys">
<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>THE PRIVACY APP OF YOUR DREAMS! :3</p>
</h1>
<div align="center">
<p>Be anonymous while watching videos, gaming, and listening to music on Poke - the free privacy front-end!</p>
</div>
<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>
<img src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg" alt="Stand with Ukraine">
<img src="https://codeberg.org/ashley/pages/raw/branch/main/images/trans-badge.svg">
<img src="https://codeberg.org/ashley/pages/raw/branch/main/images/free-Palestine.svg"><br>
<a href="https://codeberg.org/ashley/poke/src/branch/main/LICENSE">
<img src="https://img.shields.io/badge/License-GPL--3.0--or--later-FF6666" alt="GPL-3.0-or-later SPDX License">
</a>
<img src="https://img.shields.io/badge/Powered%20by-GNU/Linux-333333?logo=gnu" alt="GNU/Linux">
<img src="https://img.shields.io/badge/Web%20Server-Nginx-009639?logo=nginx&logoColor=white" alt="Nginx">
<br> <img src="https://img.shields.io/badge/Backend-Express.js-000000?logo=express" alt="Express.js">
<img src="https://img.shields.io/badge/Frontend-EJS-F4D03F" alt="EJS">
<img src="https://img.shields.io/badge/Language-JavaScript-F7DF1E?logo=javascript&logoColor=black" alt="JavaScript">
</div>
<br>
<img src="https://codeberg.org/ashley/pages/raw/branch/main/Untitled.webp">
## Welcome!
Welcome to Poke (formerly PokeTube), the privacy-friendly YouTube front-end built with the invidious API!
## Features
| <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> |
| - | - |
| <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>☁️ PokeWeather</h3>Check The weather privately on PokeWeather!!! | <h3>🎶 And...</h3>Ambient mode, HQ audio, and even more! :3 |
## No Non-Free Codec Needed
Poke uses Free Software codecs! No non-free components included :3
## Hosting Poke
### NodeJS
1. **Install Packages**
- Fedora/RHEL GNU/linux: `$ sudo dnf install git make gcc libcurl nodejs python libcurl g++ curl-config`
- Debian/Ubuntu GNU/linux: `$ sudo apt install git make gcc libcurl4-openssl-dev nodejs npm python g++`
- Alpine Linux (non-gnu): `$ apk add git nodejs npm python make gcc g++ libcurl curl-dev`
2. **Clone Repo**
- Codeberg: `$ git clone https://codeberg.org/ashley/poke.git`
- GitHub: `$ git clone https://github.com/ashley0143/poke.git`
reccomended unoffical mirrors:
- git.lgbt: `$ git clone https://git.lgbt/mirror/poke.git` [sync every 10mins]
- nin0git :`$ git clone https://git.nin0.dev/mirrors/poke.git` [sync every 10mins]
not reccomended, unstable
- none!!! yippee
3. **Install Dependencies**
- `$ cd poke`
- `$ npm install`
4. **Start Server**
- `$ node server.js`
Congrats! Poke should now be running on `localhost:6003`! 🎉
## Poke Community
Join us on [Discord](https://discord.poketube.fun/) ! I promise we're cool! <3
or if u like fedi, we host [PokeSocial](https://social.poketube.fun) as well :3
## The Legal Stuff (boring tbh)
the main parts of the project is Under GPL-3.0-OR-LATER :3
see https://poketube.fun/license
see the each sections LICENSE tho!!
Copyleft 2021-202x Poke Project of poke initative, mostly ashley0143
Trans rights!
https://initiative.poketube.fun/
poke proudly does not support the ["source first"](https://sourcefirst.com/) or ["open source"](https://opensource.org) movement :3
we support the free software movement (fsf.org)
please dont use the term "open source", see gnu.org/not-open-source for more information on why its a wrong term to use!
[Code Of conduct](https://codeberg.org/Ashley/poke/src/branch/main/CODE_OF_CONDUCT.md)
<hr>
[Privacy Policy](https://poketube.fun/privacy)
TL;DR: we dont collect or share your personal info that's it lol
<hr>
<p align="center"> <a href="https://www.amd.com/en/products/processors/server/epyc/7003-series/amd-epyc-7543.html"> <img width="65" height="65" src="https://codeberg.org/ashley/pages/raw/branch/main/amd.jpeg" alt="AMD EPYC"> </a> <a href="https://ubuntu.com/server"> <img width="65" height="65" src="https://res.cloudinary.com/canonical/image/fetch/f_auto,q_auto,fl_sanitize,w_317/https%3A%2F%2Fassets.ubuntu.com%2Fv1%2Ff76dd871-ubuntu-certified.png" alt="Ubuntu Certified"> </a> </p> <p align="center"> <small>Poke is proudly powered by AMD + Ubuntu servers!!!!!!!!!! (via Skrime Hosting). Parts of Poke ran on Glitch.com from <i>20212023</i>.</small> </p> <p align="center"> <a href="https://glitch.com/"> <img src="https://cdn.glitch.global/d68d17bb-f2c0-4bc3-993f-50902734f652/glitch-fastly-lock-up.svg" alt="Glitch logo"> </a> </p>