poke-on-astro-experiment/README.md

# 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
    - [ ] Spanish
    - [ ] Russian
    - [x] Japanese
 - [ ] Inline Player
 - [ ] Search
    - Filters
    - Auto Complete
    - Platform Toggle (Web/Youtube/Twitch)
 - [ ] User Settings
    - [ ] Invidious Server
    - [ ] Proxy
    - [ ] Video Player
    - [ ] Theme
    - [ ] Import/Export YouTube Subscription (may need entire new account system, heck!)
 - [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/.
```