Toloka2WebV2/README.md

116 lines
5.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<br/>
<div align="center">
<img src="https://external-content.duckduckgo.com/iu/?u=https%3A%2F%2Fwww.kindpng.com%2Fpicc%2Fm%2F101-1010609_google-material-design-logo-material-design-logo-png.png&f=1&nofb=1&ipt=ebae863dc3f42d9ee9ce4b5090a9c14757e81bd0008179a34af9eaefd1a019b8&ipo=images" alt="Logo" width="80" height="80">
</a>
<h3 align="center">Material Toloka2Web v2</h3>
<p align="center">
Моя версія Toloka2Web на базі MD3/MY
</p>
</div>
## Про цей проект
Зручний веб-сайт для завантаження аніме з Толоки. ~~Fuck you~~ релізери з толоки. Ненавиджу вас, тому зробив оцю штуку, яка сама мені буде завантажувати аніме та робити красивий неймінг, яка підходить Jellyfin.
Цей проект базується на Toloka2Web від maksii. Я хочу зробити простий, але красивий та головне - під дизайн Material Design 3 + Material You. Також у планах зробити застосунок під Android.
### Що було використано
- [Python+Flask](https://flask.palletsprojects.com/en/3.0.x/)
- [Toloka2Python](https://github.com/CakesTwix/toloka2python)
- [Toloka2MediaServer](https://github.com/CakesTwix/Toloka2MediaServer)
- [BeerCSS](https://www.beercss.com/)
- [js-cookie](https://www.npmjs.com/package/js-cookie)
- [Vite](https://vitejs.dev/)
- [Vue](https://vuejs.org/)
## Початок
Для встановлення цього проекту, вам потрібно встановити Python3 та усі залежності.
### Встановлення
##### Завантаження репозиторію до себе
```sh
git clone https://git.cakestwix.com/CakesTwix/Toloka2WebV2 && cd Toloka2WebV2/
```
##### Налаштування Python
1. Створимо віртуальне середовище Python
```sh
python -m venv .venv
```
2. Встановлюємо усі залежності
```sh
pip install -r requirements.txt
```
##### Збірка Frontend
1. Переходимо до директорії frontend/
```sh
cd frontend/
```
2. Встановлюємо усі залежності
```sh
npm install
```
3. Збираємо сам сайт
```sh
npm run build
```
##### Написання конфігу
Поки що не можна запустити як є, у планах зробити зручне налаштування, але не на часі.
- `data/app.ini` - це загальний конфіг, де вказується логгірование, торрент-клієнт та ваш акаунт до Толоки. Для більш детальних прикладів - [Toloka2MediaServer](https://github.com/CakesTwix/Toloka2MediaServer)
- `data/titles.ini` - це не зовсім конфіг, але тут зберігаються налаштовані тайтли для автоматичного завантаження до вашого серверу.
##### Запуск!
1. Запускаємо простий скріпт run.py
```sh
python run.py
```
## Використання
Якщо конфіг `data/app.ini` написан правильно, веб запрацює вже на http://127.0.0.1:5000/ та вже буде готовий до використання
| Головна | Додавання нового торренту |
| ---------------------- | ---------------------- |
| ![](assets/home.png) | ![](assets/add.png) |
| Налаштування | Про застосунок |
| ![](assets/settings.png) | ![](assets/about.png) |
## У планах
- [ ] Редагування торренту
- [ ] Налаштування
- [ ] Редагування `data/app.ini`
- [ ] **Перший запуск без редагування конфігів**
- [X] Додати скріншоти після релізу
- [] **Зробити рефакторінг коду**
- [X] API
- [ ] Застосунок під Android
- [ ] ntfy повідомлення
## Внески
Внески є тим, що робить спільноту відкритого коду таким дивовижним місцем для навчання, натхнення та творчості. Будь-який ваш внесок буде дуже вдячний.
Якщо у вас є пропозиція, як зробити цей проект кращим, будь ласка, створіть форк репозиторію і створіть pull request. Ви також можете просто відкрити issue з тегом «enhancement».
Не забудьте поставити проекту зірочку! Ще раз дякуємо!
1. Зробіть форк проекту
2. Створіть гілку фічі (`git checkout -b feature/AmazingFeature`)
3. Збережіть ваші зміни (`git commit -m 'Add some AmazingFeature'`)
4. Зробіть пуш до гілки (`git push origin feature/AmazingFeature`)
5. Відкрийте Pull Request
## Ліцензія
Distributed under the GPLv3 License. See [GPLv3 License](https://choosealicense.com/licenses/gpl-3.0) for more information.