InkNest

<p align="center"> <img src="./.github/readme-images/icon.png" align="center" width="128" /> <p> <h1 align="center"> InkNest </h1> <div align="center"> <a href="https://discord.gg/WYwJefvWNT" style={{ marginRight: '10px', marginBottom: '10px' }}> <img alt="Discord Chat" src="https://img.shields.io/discord/1281938822275403817.svg?logo=discord&logoColor=white&logoWidth=20&labelColor=7289DA&label=Discord&color=17cf48"> </a> <a href="https://p2devs.github.io/InkNest/" style={{ marginRight: '10px', marginBottom: '10px' }}> <img alt="Website" src="https://img.shields.io/badge/Website-000000?style=flat&logo=googlechrome&logoColor=white" > </a> <a href="https://github.com/p2devs/InkNest/releases/latest" style={{ marginRight: '10px', marginBottom: '10px' }}> <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/p2devs/InkNest"> </a> <a href="https://github.com/p2devs/InkNest/blob/main/LICENSE" style={{ marginRight: '10px', marginBottom: '10px' }}> <img alt="GitHub" src="https://img.shields.io/github/license/p2devs/InkNest"> </a> </div> <p align="left"> InkNest is a free mobile app offering a vast collection of comics and manga across genres like superheroes, sci-fi, fantasy, and manga. Enjoy a seamless experience with user-friendly navigation and customizable settings. Stay updated with the latest releases and classics. With InkNest, your favorite stories and characters are always at your fingertips. </p>

🌟 Star this repository to support the developer and encourage further development of the application

⚠️ Warning Please do not attempt to upload InkNest or any of its forks to the Play Store, App Store, or any other stores on the internet. Doing so may infringe their terms and conditions, potentially resulting in legal action or immediate takedown of the app.

📑 Table of Contents

• Features
• Screenshots
• Tech Stack
• Installation
  • Prerequisites
  • Required Files
  • Setup Instructions
• Running the App
  • Android
  • iOS
• Documentation
• Project Structure
• Contributing
• Disclaimer
• Contact
• Download
• License
• InkNest Sources
• Acknowledgements

Features

• Comic & Manga Read History: Track your reading history for easy access to previously read comics.
• Bookmark Comic & Manga: Bookmark your favorite comics & manga for quick access.
• Vast Comic & Manga Library: Access a wide range of comic & manga books across various genres including superheroes, sci-fi, fantasy.
• User-Friendly Interface: Intuitive and easy-to-use navigation ensures a seamless reading experience.
• Releases updates: Stay up-to-date with new releases.
• Search and Discover: Easily find comics & manga with search functionality and explore curated collections.
• Push Notifications: We have implemented push notifications to inform users about new releases, updates.
• Offline Reading: Download comics & manga for offline reading.
• Multi-Platform Support: Available on both Android and iOS devices.
• Open Source: InkNest is open source, allowing users to contribute and improve the app.
• Community Support: Join our community on Discord for real-time support and discussion.

Screenshots

<!-- Add some screenshots here to visually showcase your application --> <p align="center"> <!-- Example: --> <img src="./.github/readme-images/screenshot.png" width="200" /> <!-- <img src="./.github/readme-images/screenshot2.png" width="200" /> --> <!-- <img src="./.github/readme-images/screenshot3.png" width="200" /> --> </p>

Tech Stack

• React Native - Cross-platform mobile framework
• Redux - State management
• Firebase - Backend services
• Docusaurus - Documentation

Installation

Prerequisites

• Node.js (>= 18.0)
• Yarn (recommended)
• Xcode
• Android Studio
• Vs Code (IDE)
• JAVA 18+

Required Files

Before running the project, make sure to add the following files:

1. google-services.json (for Android) in the android/app directory.
2. GoogleService-Info.plist (for iOS) in the ios directory.

Steps

1. Clone the repository:

   git clone https://github.com/p2devs/InkNest.git
   cd InkNest
   

2. Install dependencies:

   yarn install
   

3. Start the development server:

   yarn start
   

Running the App

Running on Android

1. Start the Android emulator or connect an Android device.

2. Run the following command:

   yarn android
   

Running on iOS

1. Install CocoaPods dependencies:

   cd ios
   pod install
   cd ..
   

2. Start the iOS simulator or connect an iOS device.

3. Run the following command:

   yarn ios
   

Documentation

The documentation is managed using Docusaurus. To view the documentation locally:

1. Navigate to the docs directory:

   cd docs
   

2. Install dependencies:

   yarn install
   

3. Start the documentation server:

   yarn start
   

Project Structure

InkNest/
├── android/                # Android-specific code
├── ios/                    # iOS-specific code
├── src/                    # Source code
│   ├── Components/         # Reusable UI components
│   ├── Constants/          # App constants and configurations
│   ├── Navigation/         # Navigation setup
│   ├── Redux/              # State management
│   ├── Screens/            # App screens
│   └── Utils/              # Utility functions
├── docs/                   # Documentation using Docusaurus
├── __tests__/              # Tests
└── ...                     # Configuration files

Contributing

We welcome contributions! Please read our Contributing Guidelines for more details.

DISCLAIMER

• InkNest only scrapes links from various websites, making it easier for users to find manga and comics.
• Neither InkNest nor its developers/staff host any of the content found within the app. All images and manga/comic information in the app are sourced from various public APIs.
• Additionally, all manga/comic links in InkNest are obtained from various third-party manga hosting websites.
• InkNest and its owners aren't liable for any misuse of the content found inside or outside the app and cannot be held accountable for the distribution of any content found within the app.
• By using InkNest, you agree that the developers are not responsible for any content found in the app; this content may or may not come from legitimate sources.
• If internet infringement issues arise, please contact the source website. The developer does not assume any legal responsibility.

Contact

For any inquiries, feel free to reach out through one of the following channels:

• Email: inknest@capacity.rocks
• Discord: Join our community on Discord for real-time support and discussion.
• GitHub Discussions: Visit our GitHub Discussions board to engage with our community, ask questions, and find answers to common issues.

We're here to help!

Download

Get the app from our releases page.

License

This project is licensed under the GNU General Public License. See the LICENSE file for more details.

InkNest Sources

InkNest uses the following sources to provide you with the best experience:

• readcomiconline
• GlobalComix
• Bato
• MangaDex
• ColaManga
• WebToon

Acknowledgements

• React Native
• Docusaurus
• Redux
• Firebase