Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/testeurmaniak/flutter_manga_reader

A cross-platform manga reader built with Flutter.
https://github.com/testeurmaniak/flutter_manga_reader

dart drift flutter go-router isar manga manga-reader mangadex-api riverpod

Last synced: 17 days ago
JSON representation

A cross-platform manga reader built with Flutter.

Host: GitHub
URL: https://github.com/testeurmaniak/flutter_manga_reader
Owner: TesteurManiak
License: apache-2.0
Created: 2023-07-21T09:00:54.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-04-29T07:57:38.000Z (7 months ago)
Last Synced: 2024-05-02T04:01:33.560Z (7 months ago)
Topics: dart, drift, flutter, go-router, isar, manga, manga-reader, mangadex-api, riverpod
Language: Dart
Homepage:
Size: 12.1 MB
Stars: 13
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        


    



Flutter Manga Reader


[![melos](https://img.shields.io/badge/maintained%20with-melos-f700ff.svg)](https://github.com/invertase/melos)

A cross-platform manga reader built with Flutter.

This app is a Flutter clone of [Tachiyomi][tachiyomi] mainly to provide an iOS version of the app.

**This project is still a work in progress.**

## Screenshots

_WIP_

| Views | Light | Dark | Pure Dark |

| --- | --- | --- | --- |

| Library |  |  |  |

| Explorer |  |  |  |

| Details |   |   |  |

| Reader |  |  |  |

| History |  |  |  |

## Supported sources

_WIP_

| Source | Supported |

| --- | --- |

| Asura Scans | :red_circle: |

| DragonTea | :red_circle: |

| EarlyManga | :red_circle: |

| MangaBat | :white_check_mark: |

| MangaDex | :white_check_mark: |

| Mangahere | :red_circle: |

| Mangairo | :white_check_mark: |

| Mangakakalot | :white_check_mark: |

| Manganato | :white_check_mark: |

| Webtoons.com | :red_circle: |

## Features

_WIP_

* Import manga & chapters from a Tachiyomi/Mihon backup

* Global update of chapters

* Webtoon and paginated manga reading

* Download manga chapters for offline reading

* Reading history

* Language support for English and French

* Light and dark themes

* Pure Dark theme

## Run the app

This project contains 3 flavors:

- dev

- staging

- prod

To run the desired flavor either use the launch configuration in VSCode/Android Studio or use the following commands:

```sh

# Development

$ flutter run --flavor dev --target lib/main_dev.dart

# Staging

$ flutter run --flavor staging --target lib/main_staging.dart

# Production

$ flutter run --flavor prod --target lib/main_prod.dart

```

## Working with Translations

This project relies on [flutter_localizations][flutter_localizations_link] and follows the [official internationalization guide for Flutter][internationalization_guide_link].

### Adding Strings

1. To add a new localizable string, open the `app_fr.arb` file at `lib/l10n/arb/app_fr.arb`.

```arb

{

    "@@locale": "fr",

    "counterAppBarTitle": "Compteur"

}

```

2. Then add a new key/value and description

```arb

{

    "@@locale": "fr",

    "counterAppBarTitle": "Compteur",

    "helloWorld": "Bonjour le monde"

}

```

3. Generate the strings

```sh

$ flutter gen-l10n

```

4. Use the new string

```dart

import 'package:flutter_manga_reader/core/core.dart';

@override

Widget build(BuildContext context) {

  final strings = context.strings;

  return Text(strings.helloWorld);

}

```

### Adding Supported Locales

Update the `CFBundleLocalizations` array in the `Info.plist` at `ios/Runner/Info.plist` to include the new locale.

```xml

CFBundleLocalizations

    en

    fr

```

### Adding Translations

1. For each supported locale, add a new ARB file in `lib/l10n/arb`.

```

├── l10n

│   ├── arb

│   │   ├── app_en.arb

│   │   └── app_fr.arb

```

2. Add the translated strings to each `.arb` file:

`app_en.arb`

```arb

{

    "@@locale": "en",

    "counterAppBarTitle": "Counter"

}

```

`app_fr.arb`

```arb

{

    "@@locale": "fr",

    "counterAppBarTitle": "Compteur"

}

```

## Code generation

This project uses multiple code generation tools:

- [flutter_gen_runner][flutter_gen_runner_link]: To generate type-safe access to assets

- [freezed][freezed_link]: To reduce the boilerplate when writing override of `toString`, `==`, `hashCode` and `copyWith` methods

- [go_router_builder][go_router_builder_link]: To generate type-safe routes

- [json_serializable][json_serializable_link]: To generate type-safe JSON serialization/deserialization

- [theme_tailor][theme_tailor_link]: To reduce the boilerplate when writing `ThemeExtensions`s

All of these tools will generate code when running the following command:

```sh

$ dart run build_runner build

```

## Generating Icons

This project uses [flutter_launcher_icons][flutter_launcher_icons_link] to generate the app icons. To modify the icons follow these steps:

1. Replace the `icon.png` file at `assets/launcher_icons/icon.png` with your own icon. And edit the options in `pubspec.yaml` how you see fit.

2. Run the following command:

```sh

$ dart run flutter_launcher_icons

```

## Generating Splash Screens

This project uses [flutter_native_splash][flutter_native_splash_link] to generate the splash screens. To modify the splash screens follow these steps:

1. Replace the `splash.png` file at `assets/splash/splash.png` with your own splash screen. And edit the options in `pubspec.yaml` how you see fit.

2. Run the following command:

```sh

$ dart run flutter_native_splash:create

```

## Download

You can download the nightly build from [here](https://github.com/TesteurManiak/flutter_manga_reader/actions/workflows/nightly.yml).

## License

This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

## Credits

* [Tachiyomi][tachiyomi]: For providing the inspiration for this project

* [MangaDex][manga_dex]: For providing the API used in this project

## Disclaimer

The developer of this application does not have any affiliation with the content providers available.

[flutter_localizations_link]: https://api.flutter.dev/flutter/flutter_localizations/flutter_localizations-library.html

[internationalization_guide_link]: https://docs.flutter.dev/accessibility-and-localization/internationalization

[flutter_gen_runner_link]: https://pub.dev/packages/flutter_gen_runner

[freezed_link]: https://pub.dev/packages/freezed

[go_router_builder_link]: https://pub.dev/packages/go_router_builder

[json_serializable_link]: https://pub.dev/packages/json_serializable

[theme_tailor_link]: https://pub.dev/packages/theme_tailor

[flutter_launcher_icons_link]: https://pub.dev/packages/flutter_launcher_icons

[flutter_native_splash_link]: https://pub.dev/packages/flutter_native_splash

[manga_dex]: https://api.mangadex.org

[tachiyomi]: https://tachiyomi.org