1
0
Fork 0
This repository has been archived on 2024-12-03. You can view files and clone it, but cannot push or open issues or pull requests.
poke-on-astro-experiment/README.md
2024-06-22 17:03:44 -04:00

70 lines
2.2 KiB
Markdown

# Poke, but built on Astro
![Landing Preview](https://md.sudovanilla.org/images/poke-astro-42.png)
This repo is only a proof of concept to see how Poke will run in Astro. A lot of code will be used from [MinPluto](https://ark.sudovanilla.org/MinPluto/MinPluto/), as it's a YouTube frontend built on Astro and inspired by Poke.
## Todo List
- [ ] i18n
- [x] English
- [x] Japanese
- [ ] French 🚬
- [ ] Spanish
- [ ] Russian
- [ ] Inline Player
- [ ] Dedicated Redirect Page
- [ ] Should pull from instances list (git.poketube.fun, not Codeberg)
- [ ] Search
- Filters
- Auto Complete
- [ ] User Settings
- [ ] Invidious Server Selection
- [ ] SafeTwitch Backend Server Selection
- [ ] Platform Selection (YouTube/Twitch)
- [ ] Video Player
- [ ] Toggle:
- [ ] Proxy
- [ ] Audio Only
- [ ] Autoplay
- [ ] Theme
- [ ] Preferred Language (For audio track on YouTube)
- [ ] Custom CSS/JS
- [ ] Import/Export YouTube Subscription
- [ ] Import/Export Poke User Settings
- [x] Add Twitch Support, use [SafeTwitch Backend](https://codeberg.org/SafeTwitch/safetwitch-backend)
## Build
> Instructions assume you're using Bun as the package manager, which is preferred for Astro projects.
### Requirements
- git
- [Bun](https://bun.sh) (NPM/NodeJS not required 😄)
### Build and Run
Clone the repository:
```bash
git clone https://codeberg.org/korbs/poke-but-in-astro.git
cd ./poke-but-in-astro/
```
Install packages:
```bash
bun install
```
Run:
```bash
bun start # or use "bunx --bun astro dev"
```
It's that easy.
## License
```
Copyright (C) 2024 SudoVanilla
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.
```