Skip to content

A modern manga and adult Korean manhwa reading application built with React, Vite, and Tailwind CSS. Powered by the MangaDex API with full PWA support and native Android app.

Notifications You must be signed in to change notification settings

MineoreYT/InkStream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

InkStream - Manga & Manhwa Reading App

A modern manga and adult Korean manhwa reading application built with React, Vite, and Tailwind CSS. Powered by the MangaDex API with full PWA support and native Android app.

InkStream

✨ Features

Reading Experience

  • Browse popular manga and manhwa
  • Real-time search with suggestions
  • Category-based browsing
  • Full-screen reader with keyboard navigation
  • Auto-scroll to top when changing pages/chapters

Multi-Platform Support

  • Web App - Works in any modern browser
  • PWA - Install as app on mobile/desktop
  • Android APK - Native Android app via Capacitor
  • Responsive design for all screen sizes

User Experience

  • Modern UI with Tailwind CSS
  • Fast performance with Vite
  • Toast notifications
  • Local storage for preferences
  • Clean, intuitive interface

🛠️ Tech Stack

Category Technology
Frontend React 19
Build Tool Vite 7
Styling Tailwind CSS v3.4
Routing React Router DOM v7
HTTP Client Axios
Icons Lucide React
Mobile Capacitor (Android)
API MangaDex API

🚀 Getting Started

Prerequisites

  • Node.js v18 or higher
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/MineoreYT/InkStream.git
cd manga-app

# Install dependencies
npm install

# Start development server
npm run dev

Open http://localhost:5173 in your browser.

Build for Production

npm run build
npm run preview

Mobile App

PWA Installation

  1. Visit the deployed site on your mobile browser
  2. Click "Add to Home Screen" or use the install prompt
  3. The app will be installed like a native app

Android APK

The Android APK is automatically built via GitHub Actions when code is pushed to main.

  1. Go to the Actions tab on GitHub
  2. Find the latest successful build
  3. Download the InkStream.apk artifact
  4. Install on your Android device

Adult Content (Manhwa 18+)

InkStream includes a dedicated section for adult Korean manhwa with proper safeguards:

Project Structure

manga-app/
├── api/                    # Vercel serverless functions
│   ├── manga.js           # MangaDex API proxy
│   ├── chapter-proxy.js   # Chapter image proxy
│   └── image-proxy.js     # Cover image proxy
├── public/                 # Static assets
│   ├── manifest.json      # PWA manifest
│   └── sw.js              # Service worker
├── src/
│   ├── components/        # Reusable UI components
│   ├── contexts/          # React contexts
│   ├── pages/             # Page components
│   └── services/          # API services
├── android/               # Capacitor Android project
└── .github/workflows/     # GitHub Actions (APK build)

Available Scripts

Command Description
npm run dev Start development server
npm run build Build for production
npm run preview Preview production build
npm run lint Run ESLint
npm run android:sync Sync Capacitor with Android
npm run android:build Build Android project

Deployment

Vercel (Recommended)

  1. Connect your GitHub repository to Vercel
  2. Vercel will auto-detect Vite and deploy
  3. Serverless functions in /api folder work automatically

Environment Variables

No environment variables required - the app uses public APIs.

Credits

API

Image Proxies

  • corsproxy.io - CORS proxy for chapter pages
  • images.weserv.nl - Image proxy fallback

Technologies

  • React Team for the amazing framework
  • Tailwind CSS for utility-first styling
  • Vite for lightning-fast builds
  • Capacitor for native mobile support

License

This project is for educational purposes. Please respect MangaDex's terms of service and the rights of manga creators and publishers.

License

This project is for educational and demonstration purposes only.

Copyright Disclaimer

  • All manga/manhwa content belongs to their respective copyright holders
  • This application does not claim ownership of any displayed content
  • Content is sourced through the public MangaDx API
  • No copyright infringement is intended

Educational Use

This project demonstrates:

  • Modern React development techniques
  • Progressive Web App (PWA) implementation
  • Mobile app development with Capacitor
  • API integration and proxy implementation
  • Responsive design with Tailwind CSS

Legal Compliance

  • Not for commercial use - This is a non-commercial educational project
  • DMCA Compliant - We respond to legitimate takedown requests
  • User Responsibility - Users must comply with local copyright laws
  • Age Verification - Proper safeguards for adult content

For detailed legal information, see LEGAL.md and TERMS.md.

Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Made with ❤️ by MineoreYT

About

A modern manga and adult Korean manhwa reading application built with React, Vite, and Tailwind CSS. Powered by the MangaDex API with full PWA support and native Android app.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages