Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
**English** | [Русский](README_RU.md)

## General

- You (contributor) are allowed to update any piece of code you see fit.
Expand Down
27 changes: 27 additions & 0 deletions CONTRIBUTING_RU.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[English](README.md) | **Русский**

## Основные правила

- Вы (участник/разработчик) можете изменять любой участок кода по своему усмотрению.
- Несколько правил
- Константы (`Constants`) должны быть объявлены в `config/Ranobe.java`.
- Соблюдайте требования к чистому коду.
- Старайтесь не добавлять сторонние библиотеки (из‑за размера пакета).
- По возможности минимизируйте размер приложения (это будет отлично).

## Добавление нового источника

- Файл для нового источника должен быть добавлен в директорию `/sources/<lang>/`.
- Имя файла должно быть `<SiteName>.java`.
- Реализуйте интерфейс `Source.java` для добавления нового источника.
- Если по каким‑то причинам реализовать метод невозможно — выбросите корректный `Exception` с сообщением.
- Например: ```throw new Exception("Извините")```
- Перед созданием PR тщательно протестируйте новый источник.
- После завершения отправьте PR с заголовком `Add new source: <SOURCE_NAME_HERE>`; имя ветки может быть `source/<source_name>`.

## Правила

- Не определяйте поле `id` для `Novel` и `NovelItem`, так как оно вычисляется в конструкторе.
- Не определяйте поле `novelId` для `Chapter` и `ChapterItem`, так как оно также вычисляется в конструкторе;
поле `id` должно содержать номер главы в ранобэ.

2 changes: 2 additions & 0 deletions PRIVACY_POLICY.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
**English** | [Русский](README_RU.md)

# Privacy Policy

Last Updated: 25/05/2023
Expand Down
35 changes: 35 additions & 0 deletions PRIVACY_POLICY_RU.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[English](README.md) | **Русский**

# Политика конфиденциальности

Последнее обновление: 25.05.2023

Благодарим вас за использование приложения **Ranobe**, разработанного **Атул Патаре (Atul Patare)**. Эта политика конфиденциальности объясняет, как мы собираем, используем и раскрываем персональную информацию при использовании вами нашего приложения. Мы стремимся обеспечить конфиденциальность и безопасность ваших данных и прилагаем усилия к тому, чтобы быть максимально прозрачными в своих действиях.

## Сбор и использование информации

Приложение Ranobe **не собирает и не хранит** никаких данных. Оно не запрашивает разрешений, выходящих за рамки стандартных разрешений, доступных по умолчанию на вашем устройстве. Вся информация в приложении извлекается из внешних источников посредством HTTP‑запросов. На серверы этих внешних источников **не передаются** никакие персонально идентифицируемые данные.

## Типы собираемых данных

Мы **не собираем** какие‑либо персонально идентифицируемые данные при использовании вами приложения Ranobe. Ваша конфиденциальность важна для нас, и мы хотим заверить вас, что ваша личная информация остаётся безопасной и строго конфиденциальной.

## Конфиденциальность детей

Приложение Ranobe предназначено для пользователей **старше 18 лет** и не рассчитано на использование детьми младше 18 лет. Мы **сознательно не собираем** персонально идентифицируемую информацию у детей. Если вы являетесь родителем или опекуном и узнали, что ваш ребёнок передал личную информацию по электронной почте, пожалуйста, свяжитесь с нами, чтобы мы могли предпринять необходимые меры. Мы рекомендуем присматривать за использованием приложения детьми, чтобы убедиться, что они не имеют доступ к неподходящему контенту.

## Ссылки на другие сайты

Приложение Ranobe может содержать ссылки на внешние ресурсы, такие как репозиторий GitHub, приглашение в Discord и другие относящиеся к делу репозитории. Кроме того, в приложении могут присутствовать ссылки для загрузки внешнего контента. Важно отметить, что **все функции приложения выполняются исключительно на вашем устройстве**, а внешняя информация извлекается из различных источников.

## Изменения в настоящей Политике конфиденциальности

Мы можем обновлять эту Политику конфиденциальности по мере дальнейшего развития и улучшения функциональности приложения. Все вносимые изменения будут заранее доведены до пользователей. Вы несёте ответственность за **периодический просмотр** настоящей Политики конфиденциальности. Продолжение использования приложения после внесения изменений будет означать ваше **принятие обновлённой версии**.

## Отказ от ответственности

Приложение Ranobe разработано для чтения и обзора лёгких новелл. Мы **не несём ответственности** за то, как вы решите использовать данное программное обеспечение, и отказываемся от ответственности за любые потери или убытки, возникшие в результате его использования.

## Свяжитесь с нами

Мы ценим ваши вклады и предложения по улучшению приложения Ranobe. Если у вас есть вопросы, претензии или вы хотите внести вклад в проект, пожалуйста, обращайтесь напрямую к разработчику по электронной почте: **atulpatare99@gmail.com** или открывайте issue в официальном репозитории на GitHub по ссылке: [https://github.com/ranobe-org/ranobe/issues/new](https://github.com/ranobe-org/ranobe/issues/new).
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@
<h3 align="center"><samp>Support with a Star :star:!</samp></h3>

---------------

<p align="center">
<a href="README.md"><strong>English</strong></a> •
<a href="README_RU.md"><strong>Русский</strong></a>
</p>

### Features
- Read Novels
- No Ads, No Paywall
Expand Down
98 changes: 98 additions & 0 deletions README_RU.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<p align="center">
<img width="300" src="https://github.com/ranobe-org/ranobe/raw/main/assets/app.gif" alt="аннимация приложения">
</p>
<div align="center">
<h2><samp>Р.А.Н.О.Б.Э</samp></h2>
<samp>Простой, расширяемый читалка ранобэ</samp>
<br/><br/>
<a href="https://play.google.com/store/apps/details?id=org.ranobe.downloader">
<img height='80' src="https://github.com/ranobe-org/ranobe/blob/main/assets/google-play.png?raw=true" alt="Play Store">
</a>
<br/><br/>
<a href="https://github.com/ranobe-org/ranobe/releases/latest" title="Скачать">
<img height='30' src="https://img.shields.io/badge/download-2da44e?style=flat&logo=android&logoColor=white" alt="Скачать" title="Скачать">
</a>
<a href="https://apt.izzysoft.de/fdroid/index/apk/org.ranobe.ranobe" title="Скачать из Izzydroid">
<img height='30' src="https://img.shields.io/endpoint?url=https://apt.izzysoft.de/fdroid/api/v1/shield/org.ranobe.ranobe" alt="Скачать из Izzydroid">
</a>
<a href="https://ranobe.atulpatare.in" title="Сайт">
<img height='30' src="https://img.shields.io/badge/website-F4F51E?style=flat&logo=internet-archive&logoColor=black" alt="Сайт" title="Сайт">
</a>
<a href="https://discord.gg/6CQ6u64dca" title="Присоединиться к Discord">
<img height='30' src="https://img.shields.io/badge/discord-5865F2?style=flat&logo=discord&logoColor=white" alt="Присоединиться к Discord" title="Присоединиться к Discord">
</a>
<a href="https://github.com/ranobe-org" title="GitHub">
<img height='30' src="https://img.shields.io/badge/github-ffffff?style=flat&logo=github&logoColor=black" alt="GitHub" title="GitHub">
</a>
</div>

---------------

<h3 align="center"><samp>Поддержи звёздочкой :star:!</samp></h3>

---------------

<p align="center">
<a href="README.md"><strong>English</strong></a> •
<a href="README_RU.md"><strong>Русский</strong></a>
</p>

### Возможности

- Чтение новелл/ранобэ
- Без рекламы и платных ограничений
- Неограниченный обзор новелл
- Многоязычные источники (вкл/выкл)
- Английский
- Русский
- Поиск по ключевым словам
- Поиск и сортировка глав
- Вертикальное непрерывное чтение
- Светлая и тёмная темы
- Настройка чтения
- Изменение размера шрифта
- Изменение цвета фона и текста
- Бионическое чтение
- Чтение без интернета и библиотека
- История чтения

----------------

### План (TODO)

#### Обязательное

- [x] базовый просмотр и чтение источников
- [x] улучшение интерфейса для страницы деталей и списка глав
- [x] сортировка глав
- [x] кэширование HTTP‑ответов (снижение нагрузки на источники)
- [x] поиск по главам
- [x] полноценная страница поиска с поиском по ключевым словам
- [x] форматирование текста в читалке (размер шрифта и выбор цвета фона/текста)
- [x] непрерывная вертикальная прокрутка в читалке
- [x] текст/изображение‑заглушка при отсутствии результатов поиска
- [x] страница настроек с выбором темы
- [x] уведомление о новых обновлениях приложения
- [x] выбор списка источников
- [x] добавление собственного источника
- [x] запоминание выбранного источника (один за раз — это правило)
- [x] база данных
- [x] добавление в библиотеку, хранение только новеллы в БД
- [x] сообщение об отсутствии ранобэ в пустой библиотеке
- [x] скачивание глав для офлайн‑чтения, всё сохраняется в БД
- [x] сохранение статуса «прочитано» для каждого элемента

#### Желательное

- [ ] продвинутые методы поиска
- [ ] инструменты управления источниками
- [ ] экспорт в X форматов
- [ ] статистика и метрики, если возможно
- [ ] резервное копирование данных и миграции
- [ ] обновления новелл
- [ ] анимации

### Отказ от ответственности

Разработчики этого приложения не имеют никакой причастности к контенту, доступному в приложении.
Приложение лишь собирает данные из источников, свободно доступных в любом веб‑браузере.
Loading