Skip to content

mkr-infinity/Revision-Master

Repository files navigation

Revision Master Logo

Revision Master

The Anime-Themed Companion for Exam Excellence
Flashcards, formulas, mock tests & AI-generated study material β€” wrapped in a manga / anime aesthetic with six anime-inspired theme worlds.

Version License React Vite Tailwind Capacitor Offline PWA

πŸ“² Download the App

πŸ“Œ Installation Steps

  1. Download the APK file
  2. Enable Install from Unknown Sources
  3. Open the APK and install
  4. Enjoy the app πŸŽ‰

πŸ›  Build & Release (quick)

  • For full, detailed build and signing instructions, see the BUILD_GUIDE.md.

Quick local commands:

# Install dependencies
npm ci

# Build web assets and sync to Android
npm run build -- --mode production
npx cap sync android

# Build debug APK
cd android && ./gradlew assembleDebug

# Build signed release AAB (after creating key.properties)
cd android && ./gradlew bundleRelease

If you want CI automation for signed builds, follow the GitHub Actions example in BUILD_GUIDE.md and store your keystore and passwords as repository secrets.


🌟 Why Revision Master?

In a world full of distractions, Revision Master is built to keep you focused. It's not just another study app; it's a precision tool designed for students who value their time and data.

πŸ›‘οΈ Privacy Focused (Local-First)

Your study habits and data are yours alone. Revision Master follows a Local-First Architecture:

  • Zero Cloud Storage: All your subjects, flashcards, and progress are stored securely on your device.
  • No Tracking: No analytics, no cookies, no hidden trackers.
  • Full Control: Export your entire database as a JSON backup anytime. We don't lock you in.

⚑ Built for Speed & Utility

  • Native Experience: Optimized for mobile with buttery-smooth animations and instant tab switching.
  • Offline Ready: Study anywhere, anytime. No internet connection required for core features.
  • AI-Powered: Generate flashcards and study materials instantly using MKR Ai (powered by Google Gemini).

What's New in v2.0.0 β€” Anime Edition

Anime Theme System

  • Full anime / manga aesthetic across every screen, popup and modal β€” not just fonts.
  • Themes are no longer plain colors β€” each one is a full anime-world style:
    Theme Anime Vibe
    Demon Slayer Tanjiro Crimson red + black/green haori checker
    My Hero Academia Deku / All Might Hero blue + Plus Ultra yellow rays
    Naruto Hokage Hidden-Leaf cream + Rasengan orange swirls
    Jujutsu Kaisen Gojo Cursed-energy violet + swirling rays
    Bleach Zanpakuto Hollow black + Reiatsu cyan slashes
    Vinland Saga Norse Frost teal + cream rune crosshatching
  • New manga elements: speech bubbles, halftones, speed lines, bold black/white borders with offset shadows, kira sparkles, chibi mascot.
  • Onboarding: chibi mascot + Skip button on every step + β˜… Offline-ready.
  • Settings β†’ Appearance β†’ "Use system default font" if you don't want the manga font.

See the full CHANGELOG.txt.


✨ Powerful Features

Feature Description
Smart Subjects Organize study material with custom icons and progress tracking
Active Recall Interactive flashcards with support for text, images, formulas
Exam Simulation Create custom mock tests to simulate real exam conditions
AI Study Buddy Generate flashcards and explanations using MKR AI
Deep Insights Track progress with statistics and performance heatmaps
Offline Study Export flashcards and decks as PDFs

Project Structure

πŸ“¦ Revision Master
β”œβ”€β”€ πŸ“± Mobile App (React + Capacitor + Vite)
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ components/        # UI components (Layout, Chatbot, modals, providers)
β”‚   β”‚   β”œβ”€β”€ context/           # AppContext (themes, user, decks, tests, AI settings)
β”‚   β”‚   β”œβ”€β”€ screens/           # App screens (Home, Flashcards, MockTests, Stats, Settings, About, Onboarding, FormulaLibrary, RecycleBin, Changelog)
β”‚   β”‚   β”œβ”€β”€ types/             # TypeScript definitions
β”‚   β”‚   β”œβ”€β”€ utils/             # AI client, PDF export, utilities
β”‚   β”‚   β”œβ”€β”€ assets/            # Icons and feature SVGs
β”‚   β”‚   β”œβ”€β”€ index.css          # Tailwind v4 + 6 anime-themed palettes + manga utilities
β”‚   β”‚   β”œβ”€β”€ App.tsx            # Main App component
β”‚   β”‚   └── main.tsx           # Entry point
β”‚   β”œβ”€β”€ public/                # Static assets
β”‚   β”œβ”€β”€ android/               # Capacitor Android native project
β”‚   β”‚   β”œβ”€β”€ app/               # Android app (build files, AndroidManifest.xml, resources)
β”‚   β”‚   └── capacitor-cordova-android-plugins/
β”‚   β”œβ”€β”€ capacitor.config.ts    # Capacitor config (StatusBar, Splash, mixed-content)
β”‚   β”œβ”€β”€ vite.config.ts         # Vite + PWA + code splitting for fast loads
β”‚   β”œβ”€β”€ tsconfig.json          # TypeScript configuration
β”‚   └── package.json           # Dependencies
β”‚
β”œβ”€β”€ 🌐 Website (React + Vite + Shadcn UI)
β”‚   β”œβ”€β”€ website/src/
β”‚   β”‚   β”œβ”€β”€ components/        # UI components (Hero, Features, Screenshots, Footer, etc.)
β”‚   β”‚   β”œβ”€β”€ pages/             # Pages (Home, not-found)
β”‚   β”‚   β”œβ”€β”€ hooks/             # Custom hooks
β”‚   β”‚   β”œβ”€β”€ lib/               # Utilities
β”‚   β”‚   β”œβ”€β”€ App.tsx
β”‚   β”‚   └── main.tsx
β”‚   β”œβ”€β”€ website/public/        # Static assets
β”‚   └── website/package.json
β”‚
β”œβ”€β”€ πŸ“š Assets
β”‚   β”œβ”€β”€ assets/icons/          # App icons
β”‚   β”œβ”€β”€ assets/features/       # Feature SVGs
β”‚   β”œβ”€β”€ assets/screenshotv2/   # App screenshots
β”‚   └── assets/mockups/        # UI mockups
β”‚
β”œβ”€β”€ πŸ“– Documentation
β”‚   β”œβ”€β”€ README.md              # Project overview
β”‚   β”œβ”€β”€ BUILD_GUIDE.md         # Web deployment guide
β”‚   β”œβ”€β”€ CAPACITOR_GUIDE.md     # Capacitor setup guide
β”‚   β”œβ”€β”€ CHANGELOG.txt          # Version history
β”‚   └── metadata.json          # Project metadata
β”‚
└── βš™οΈ Configuration
    β”œβ”€β”€ serve-website.js       # Website server script
    β”œβ”€β”€ update-colors.ts       # Theme color generator
    └── .github/workflows/apk.yml  # GitHub Actions β€” debug APK builder

πŸ“¦ Getting Started

🌐 Web Development

To run the project locally for development:

Tip

For a detailed guide on web deployment and hosting, see our Web Build Guide.


πŸ’– Support

Buy Me A Coffee

If you like Revision Master, please consider supporting πŸ™Œ


About

Revision Master - A smart, offline-first study app with AI-generated flashcards, mock tests, and a focus timer.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages