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

74 lines
2.4 KiB
Markdown
Raw Normal View History

2024-06-14 05:29:01 +00:00
# Poke, but built on Astro
2024-06-24 02:35:54 +00:00
![Landing Preview](https://md.sudovanilla.org/images/poke-astro-32.png)
2024-06-22 02:30:19 +00:00
2024-06-21 06:41:45 +00:00
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
2024-06-21 09:19:58 +00:00
- [x] English
2024-06-22 21:03:44 +00:00
- [x] Japanese
- [ ] French 🚬
2024-06-21 06:41:45 +00:00
- [ ] Spanish
- [ ] Russian
2024-06-27 04:55:49 +00:00
- [x] Inline Player (Tested, works)
2024-06-24 02:35:54 +00:00
- [x] Mobile Support
2024-06-22 21:03:44 +00:00
- [ ] Dedicated Redirect Page
- [ ] Should pull from instances list (git.poketube.fun, not Codeberg)
2024-06-22 20:52:45 +00:00
- [ ] Search
2024-06-24 02:35:54 +00:00
- [ ] Revamp Experience
- [ ] Filters
- [x] Auto Complete
2024-06-23 08:29:06 +00:00
- [ ] Video Page
- [ ] Toggle:
- [ ] Audio Only
- [ ] Autoplay
2024-06-21 10:35:36 +00:00
- [ ] User Settings
2024-06-22 21:03:44 +00:00
- [ ] Invidious Server Selection
- [ ] SafeTwitch Backend Server Selection
- [ ] Platform Selection (YouTube/Twitch)
2024-06-21 10:35:36 +00:00
- [ ] Video Player
2024-06-22 21:03:44 +00:00
- [ ] Toggle:
- [ ] Proxy
- [ ] Theme
- [ ] Preferred Language (For audio track on YouTube)
- [ ] Custom CSS/JS
2024-06-23 08:29:06 +00:00
- [ ] Import/Export YouTube Subscription (Use local session, no database crap)
2024-06-22 21:03:44 +00:00
- [ ] Import/Export Poke User Settings
2024-06-22 20:52:45 +00:00
- [x] Add Twitch Support, use [SafeTwitch Backend](https://codeberg.org/SafeTwitch/safetwitch-backend)
2024-06-21 06:41:45 +00:00
## Build
> Instructions assume you're using Bun as the package manager, which is preferred for Astro projects.
### Requirements
- git
2024-06-22 21:03:44 +00:00
- [Bun](https://bun.sh) (NPM/NodeJS not required 😄)
2024-06-21 06:41:45 +00:00
### 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/.
```