1
Fork 0
This repository has been archived on 2024-12-10. You can view files and clone it, but cannot push or open issues or pull requests.
poke-on-astro-experiment/README.md

53 lines
1.6 KiB
Markdown
Raw Normal View History

2024-06-14 00:29:01 -05:00
# Poke, but built on Astro
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
2024-06-21 04:19:58 -05:00
- [x] English
2024-06-21 01:41:45 -05:00
- [ ] Spanish
- [ ] Russian
2024-06-21 04:19:58 -05:00
- [x] Japanese
2024-06-21 01:41:45 -05:00
- [ ] Inline Player
2024-06-21 05:35:36 -05:00
- [ ] User Settings
- [ ] Invidious Server
- [ ] Proxy
- [ ] Video Player
- [ ] Theme
- [ ] Import/Export YouTube Subscription (may need entire new account system, heck!)
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
- [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/.
```