poke-on-astro-experiment/README.md

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

			`### Requirements`
			`- git`
Update the todo list 2024-06-22 16:03:44 -05:00			`- [Bun](https://bun.sh) (NPM/NodeJS not required 😄)`
update 2024-06-21 01:41:45 -05: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/.`
			```