Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos and reformat some code #89

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
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
42 changes: 28 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,44 @@
## Openlib Contribution guidelines
# Openlib contribution guidelines

### Getting started
## Getting started

- This project is powered by Flutter. Make sure you have the latest version of Flutter.
- Flutter powers this project. Make sure you have the latest version of Flutter.

- If you want to fix bug or implement a new feature, that already mention in the [issues](https://github.com/dstark5/Openlib/issues), please, assign this issue to you and/or comment about it.
- If you want to fix a bug or implement a new feature already mentioned in
the [issues](https://github.com/dstark5/Openlib/issues), please assign this issue to you and/or comment about it.

- Whether you have to implement new feature, please, open an issue or discussion regarding it to ensure it will be accepted.
- Whether you have to implement a new feature, please, open an issue or discussion regarding it to ensure it will be
accepted.

### Open a pull request
When you're done making changes and you'd like to propose them for review, open your PR (pull request). You can use the GitHub user interface for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally, to view changes and run your tests on your machine.
## Open a pull request

### Submit your PR & get it reviewed
- Once you submit your PR, others from the Docs community will review it with you. The first thing you're going to want to do is a [self review](#self-review).
When you're done making changes, and you would like to propose them for review, open your PR (pull request). You can use
the
GitHub user interface for some small changes, like fixing a typo or updating a readme. You can also fork the repo and
then clone it locally, to view changes and run your tests on your machine.

## Submit your PR & get it reviewed

- Once you submit your PR, others from the Docs community will review it with you. The first thing you're going to want
to do is a [self-review](#self-review).
- After that, we may have questions, check back on your PR to keep up with the conversation.
- We may ask for changes to be made before a PR can be merged. You can make any other changes in your fork, then commit them to your branch.
- We may ask for changes to be made before a PR can be merged. You can make any other changes in your fork, then commit
them to your branch.

## Self-review

### Self review
You should always review your own PR first.

For content changes, make sure that you:

- [ ] Confirm the changes doesn't break anything else.
- [ ] Compare your pull request's source changes to staging to confirm that the output matches the source and that everything is rendering as expected. This helps spot issues like typos, content that doesn't follow the style guide, or content that isn't rendering due to versioning problems.
- [ ] Compare your pull request's source changes to staging to confirm that the output matches the source and that
everything is rendered as expected. This helps spot issues like typos, content that doesn't follow the style guide,
or content that isn't rendered due to versioning problems.
- [ ] Review the content for technical accuracy.
- [ ] Copy-edit the changes for grammar or spelling mistakes.

### Notes
- Please, do not modify readme and other information files (except for typos).
## Notes

- Please don't modify readme and other information files (except for typos).
- Avoid adding new dependencies unless required. APK size is important.
84 changes: 47 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@

# Openlib

#### An Open source app to download and read books from shadow library ([Anna’s Archive](https://annas-archive.org/)).
#### An open-source app to download and read books from shadow library ([Anna’s Archive](https://annas-archive.org/)).

[![made-with-flutter](https://img.shields.io/badge/Made%20with-Flutter-4361ee.svg?style=for-the-badge)](https://flutter.dev/)
[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-e63946.svg?style=for-the-badge)](https://opensource.org/licenses/)
[![made-with-flutter](https://img.shields.io/badge/Made%20with-Flutter-4361ee.svg?style=for-the-badge)](https://flutter.dev/)
[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-e63946.svg?style=for-the-badge)](https://opensource.org/licenses/)
[![Latest release](https://img.shields.io/github/release/dstark5/Openlib.svg?style=for-the-badge)](https://github.com/dstark5/Openlib/releases)

[<img src="github_releases.png"
alt="Get it on GitHub"
height="60">](https://github.com/dstark5/Openlib/releases)
alt="Get it on GitHub"
height="60">](https://github.com/dstark5/Openlib/releases)
[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png"
alt="Get it on IzzyOnDroid"
height="60">](https://android.izzysoft.de/repo/apk/com.app.openlib)
alt="Get it on IzzyOnDroid"
height="60">](https://android.izzysoft.de/repo/apk/com.app.openlib)
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
height="60">](https://f-droid.org/en/packages/com.app.openlib/)
alt="Get it on F-Droid"
height="60">](https://f-droid.org/en/packages/com.app.openlib/)

</div>

## Note 📝

**WARNING:** This App Is In Beta Stage, So You May Encounter Bugs. If You Do, Open An Issue In Github Repository.
**WARNING:** This app is in beta stage, so you may encounter bugs. If you do, open an issue in the GitHub repository.

#### Publishing Openlib, Or Any Fork Of It In The Google Play Store Violates Their Terms And Conditions.
#### Publishing Openlib, or any fork of it in the Google Play Store violates their terms and conditions.

## Screenshots 🖼️

Expand All @@ -41,58 +41,61 @@

## Description 📖

##### Openlib Is An Open Source App To Download And Read Books From Shadow Library ([Anna’s Archive](https://annas-archive.org/)). The App Has Built In Reader to Read Books.
##### Openlib is an open-source app to download and read books from shadow library ([Anna’s Archive](https://annas-archive.org)). The app has a built-in reader to read books.

##### As [Anna’s Archive](https://annas-archive.org/) Doesn't Have An API. The App Works By Sending Request To Anna’s Archive And Parses The Response To objects. The App Extracts The Mirrors From Response And Downloads The Book.
##### As [Anna’s Archive](https://annas-archive.org) doesn't have an API, the app works by sending requests to Anna’s Archive and parsing the response to objects. The app extracts the mirrors from response and downloads the book.

## Features ✨

- Trending Books
- Download And Read Books With In-Built Viewer
- Supports Epub And Pdf Formats
- Open Books In Your Favourite Ebook Reader
- Filter Books
- Sort Books

- Trending books
- Download and read books with built-in viewer
- Supports Epub and PDF formats
- Open books in your favorite ebook reader
- Filter books
- Sort books

## Roadmap 🎯

- Adding More Book Format supports (cbz,cbr,azw3,etc...)
- Adding Support For Background Downloads
- Adding Support For Multiple Downloads
- Adding more book format supports (cbz, cbr, azw3, etc...)
- Adding support for background downloads
- Adding support for multiple downloads

## Building from Source
## Building from source

- If you don't have Flutter SDK installed, please visit official [Flutter](https://flutter.dev) site.
- If you don't have Flutter SDK installed, please visit the official [Flutter](https://flutter.dev) site.

- Git Clone The Repo
- Git clone the repository

```
git clone https://github.com/dstark5/Openlib.git
```

- Run the app with Android Studio or VS Code. Or the command line:
- Run the app with Android Studio or VS Code, or the command line:

```
flutter pub get
flutter run
```

- To Build App Run:
- To build the app, run:

```
flutter build
```
- The Build Will Be In './build/app/outputs/flutter-apk/app-release.apk'

- The build will be in './build/app/outputs/flutter-apk/app-release.apk'

## Contributor required 🚧

We are actively seeking contributors. Whether you're a seasoned developer or just starting out, we welcome your contributions to help make this project even better!
We're actively seeking contributors. Whether you're a seasoned developer or just starting out, we welcome your
contributions to help make this project even better!

## Contribution 💝

Whether you have ideas, design changes or even major code changes, help is always welcome. The app gets better and better with each contribution, no matter how big or small!
Whether you have ideas, design changes or even major code changes, help is always welcome. The app gets better and
better with each contribution, no matter how big or small!

If you'd like to get involved See [CONTRIBUTING.md](./CONTRIBUTING.md) for the guidelines.
If you would like to get involved, see [CONTRIBUTING.md](./CONTRIBUTING.md) for the guidelines.

## Issues 🚩

Expand All @@ -102,14 +105,21 @@ Please report bugs via the [issue tracker](https://github.com/dstark5/Openlib/is

If you like Openlib, you're welcome to send a donation.

#### [Donate To Anna’s Archive.](https://annas-archive.org/donate?tier=1)
#### [Donate to Anna’s Archive.](https://annas-archive.org/donate?tier=1)

## License 📜

[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.en.html)

Openlib is a free software licensed under GPL v3.0 It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. [GNU General Public License](https://www.gnu.org/licenses/gpl.html) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Openlib is a free software licensed under GPL v3.0. It is distributed in the hope that it will be useful, but WITHOUT
ANY
WARRANTY. [GNU General Public License](https://www.gnu.org/licenses/gpl.html) as published by the Free Software
Foundation, either version 3 of the license, or (at your option) any later version.

## Disclaimer ⚠️

Openlib does not own or have any affiliation with the books available through the app. All books are the property of their respective owners and are protected by copyright law. Openlib is not responsible for any infringement of copyright or other intellectual property rights that may result from the use of the books available through the app. By using the app, you agree to use the books only for personal, non-commercial purposes and in compliance with all applicable laws and regulations.
Openlib doesn't own or have any affiliation with the books available through the app. All books are the property of
their respective owners and are protected by copyright law. Openlib is not responsible for any infringement of copyright
or other intellectual property rights that may result from the use of the books available through the app. By using the
app, you agree to use the books only for personal, non-commercial purposes and in compliance with all applicable laws
and regulations.
4 changes: 2 additions & 2 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ linter:
# `// ignore_for_file: name_of_lint` syntax on the line or in the file
# producing the lint.
rules:
# avoid_print: false # Uncomment to disable the `avoid_print` rule
# prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule
# avoid_print: false # Uncomment to disable the `avoid_print` rule
# prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule

# Additional information about this file can be found at
# https://dart.dev/guides/language/analysis-options
Expand Down
65 changes: 32 additions & 33 deletions android/app/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -1,49 +1,48 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
>
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WAKE_LOCK" />

<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
<uses-permission android:name="android.permission.READ_MEDIA_VIDEOS" />
<uses-permission android:name="android.permission.READ_MEDIA_AUDIO" />

<uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" />
>
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.WAKE_LOCK"/>

<uses-permission android:name="android.permission.READ_MEDIA_IMAGES"/>
<uses-permission android:name="android.permission.READ_MEDIA_VIDEOS"/>
<uses-permission android:name="android.permission.READ_MEDIA_AUDIO"/>

<uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="29"/>

<queries>
<intent>
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.BROWSABLE" />
<data android:scheme="https" />
<action android:name="android.intent.action.VIEW"/>
<category android:name="android.intent.category.BROWSABLE"/>
<data android:scheme="https"/>
</intent>
</queries>

<application
android:label="Openlib"
android:name="${applicationName}"
android:requestLegacyExternalStorage="true"
android:networkSecurityConfig="@xml/network_security_config"
android:icon="@mipmap/launcher_icon">
<activity
android:name=".MainActivity"
android:exported="true"
android:launchMode="singleTop"
android:theme="@style/LaunchTheme"
android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
android:hardwareAccelerated="true"
android:windowSoftInputMode="adjustResize">
android:label="Openlib"
android:name="${applicationName}"
android:requestLegacyExternalStorage="true"
android:networkSecurityConfig="@xml/network_security_config"
android:icon="@mipmap/launcher_icon">

<activity
android:name=".MainActivity"
android:exported="true"
android:launchMode="singleTop"
android:theme="@style/LaunchTheme"
android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
android:hardwareAccelerated="true"
android:windowSoftInputMode="adjustResize">
<!-- Specifies an Android theme to apply to this Activity as soon as
the Android process has started. This theme is visible to the user
while the Flutter UI initializes. After that, this theme continues
to determine the Window background behind the Flutter UI. -->

<meta-data
android:name="io.flutter.embedding.android.NormalTheme"
android:resource="@style/NormalTheme"
/>
android:name="io.flutter.embedding.android.NormalTheme"
android:resource="@style/NormalTheme"
/>
<intent-filter>
<action android:name="android.intent.action.MAIN"/>
<category android:name="android.intent.category.LAUNCHER"/>
Expand All @@ -52,7 +51,7 @@
<!-- Don't delete the meta-data below.
This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
<meta-data
android:name="flutterEmbedding"
android:value="2" />
android:name="flutterEmbedding"
android:value="2"/>
</application>
</manifest>
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Modify this file to customize your launch splash screen -->
<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
<item android:drawable="?android:colorBackground" />
<item android:drawable="?android:colorBackground"/>

<!-- You can insert your own image assets here -->
<!-- <item>
Expand Down
2 changes: 1 addition & 1 deletion android/app/src/main/res/drawable/launch_background.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Modify this file to customize your launch splash screen -->
<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
<item android:drawable="@android:color/white" />
<item android:drawable="@android:color/white"/>

<!-- You can insert your own image assets here -->
<!-- <item>
Expand Down
Loading