diff --git a/README.md b/README.md new file mode 100644 index 0000000..4b0d981 --- /dev/null +++ b/README.md @@ -0,0 +1,102 @@ + +
+
+Logo + +

Material Toloka2Web v2

+

+Моя версія Toloka2Web на базі MD3/MY +

+
+ +## Про цей проект + +Зручний веб-сайт для завантаження аніме з Толоки. ~~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) + +## Початок + +Для встановлення цього проекту, вам потрібно встановити 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 + ``` + +##### Написання конфігу + +Поки що не можна запустити як є, у планах зробити зручне налаштування, але не на часі. + +- `data/app.ini` - це загальний конфіг, де вказується логгірование, торрент-клієнт та ваш акаунт до Толоки. Для більш детальних прикладів - [Toloka2MediaServer](https://github.com/CakesTwix/Toloka2MediaServer) +- `data/titles.ini` - це не зовсім конфіг, але тут зберігаються налаштовані тайтли для автоматичного завантаження до вашого серверу. + + +##### Запуск! + +1. Переходимо до app/ + ```sh + cd app/ + ``` +2. Запускаємо! + ```sh + flask run + ``` +## Використання + +Якщо конфіг `data/app.ini` написан правильно, веб запрацює вже на http://127.0.0.1:5000/ та вже буде готовий до використання + +| Головна | Додавання нового торренту | +| ---------------------- | ---------------------- | +| ![](assets/home.png) | ![](assets/add.png) | +| Налаштування | Про застосунок | +| ![](assets/settings.png) | ![](assets/about.png) | + +## У планах + +- [ ] Редагування торренту +- [ ] Налаштування + - [ ] Редагування `data/app.ini` + - [ ] **Перший запуск без редагування конфігів** +- [ ] Додати скріншоти після релізу +- [ ] **Зробити рефакторінг коду** +- [ ] 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.