Author: aezizhu | Repository: https://github.com/aezizhu/ai-reading-assistant
An intelligent, feature-rich reading companion that transforms how you interact with digital books. Built with cutting-edge web technologies and designed for the modern reader.
Transform your reading experience with an application that doesn't just store your books—it understands them. Whether you're a student, researcher, or avid reader, our AI-powered platform provides the tools you need to read smarter, not harder.
- 🧠 AI-Powered Insights: Get intelligent summaries, mind maps, and reading recommendations
- 📚 Universal Format Support: PDF, EPUB, MOBI - all in one place
- 🎯 Smart Goal Tracking: Set and achieve your reading objectives with precision
- 🌍 Multi-Language Ready: English, Chinese, Spanish with seamless switching
- 🔒 Privacy-First: 100% local storage, zero cloud dependencies
- 🎨 Beautiful Interface: Modern, responsive design that adapts to any device
- Immersive PDF Reader: Native PDF rendering with zoom, rotation, and smooth navigation
- Smart Highlighting: Multiple colors with contextual notes and easy organization
- Intelligent Notes: Categorized note-taking with automatic linking to book content
- Session Tracking: Monitor reading time, maintain streaks, and build reading habits
- Interactive Q&A: Ask questions about specific chapters or concepts
- Auto-Summarization: Get AI-generated chapter summaries and key points
- Mind Map Generation: Visual concept mapping for better understanding
- Personalized Recommendations: Discover your next great read based on your preferences
- Reading Dashboard: Beautiful charts showing your reading patterns and progress
- Goal Management: Set daily targets, track completion rates, and celebrate achievements
- Export Capabilities: Download your notes, highlights, and reading statistics
- Progress Visualization: See your reading journey with intuitive graphs and metrics
- Complete Internationalization: Every text element translated and localized
- Dynamic Language Switching: Change languages instantly without page reload
- Cultural Adaptation: Date formats, number systems, and reading directions respected
- Next.js 14 with App Router - Server-side rendering and optimal performance
- TypeScript - Type-safe development with excellent IDE support
- Tailwind CSS - Utility-first styling with custom design system
- Zustand - Lightweight, powerful state management with persistence
- react-pdf + PDF.js - Industry-standard PDF rendering and manipulation
- Framer Motion - Smooth, professional animations and transitions
- Recharts - Beautiful, responsive data visualization
- date-fns - Comprehensive date handling with internationalization
ai-reading-assistant/
├── 🎨 app/ # Next.js App Router
│ ├── globals.css # Global styles & design system
│ ├── layout.tsx # Application shell
│ ├── page.tsx # Main dashboard
│ ├── demo/ # Interactive demo
│ └── test/ # Development utilities
├── ⚙️ components/ # React components
│ ├── BookLibrary.tsx # Library management interface
│ ├── PDFReader.tsx # Advanced PDF viewer
│ ├── NotesManager.tsx # Note organization system
│ ├── AICompanion.tsx # AI chat interface
│ ├── ReadingStats.tsx # Analytics dashboard
│ ├── AddBookModal.tsx # Book addition workflow
│ └── LanguageSwitcher.tsx # Language selection UI
├── 🌐 contexts/ # React contexts
│ └── LanguageContext.tsx # Internationalization provider
├── 🔧 lib/ # Core utilities
│ ├── store.ts # Central state management
│ ├── fileUtils.ts # File processing utilities
│ └── i18n.ts # Translation system
├── 🗣️ locales/ # Translation files
│ ├── en.json # English translations
│ ├── zh.json # Chinese translations
│ └── es.json # Spanish translations
└── 📦 public/ # Static resources
- Node.js 18.0+ (LTS recommended)
- npm or yarn package manager
- Modern browser with JavaScript enabled
-
Clone & Navigate
git clone https://github.com/aezizhu/ai-reading-assistant.git cd ai-reading-assistant -
Install Dependencies
npm install # or yarn install -
Start Development Server
npm run dev # or yarn dev -
Access Application Open http://localhost:3000 in your browser
chmod +x start.sh && ./start.sh- Add Your First Book: Click "Add Book" → Upload PDF/EPUB/MOBI → Start reading
- Set Reading Goals: Navigate to Goals → Create target → Track progress automatically
- Take Smart Notes: Highlight text → Add categorized notes → Export when needed
- Chat with AI: Ask questions about content → Get summaries → Generate mind maps
- Keyboard Shortcuts: Arrow keys for page navigation, Ctrl+F for search
- Bulk Operations: Select multiple items for batch actions
- Data Export: Regular exports prevent data loss
- Goal Strategy: Set realistic daily targets for better success rates
// tailwind.config.js
module.exports = {
theme: {
extend: {
colors: {
primary: { /* Custom primary colors */ },
secondary: { /* Custom secondary colors */ }
}
}
}
}- Create
/locales/[language].json - Add language to
lib/i18n.ts - Update
LanguageSwitcher.tsx
# .env.local
NEXT_PUBLIC_AI_API_URL=your_ai_service_url
NEXT_PUBLIC_AI_API_KEY=your_api_key
NEXT_PUBLIC_ANALYTICS_ID=your_analytics_id- 100% Local Storage: All data remains on your device
- No Cloud Dependencies: Fully functional offline
- Client-Side Processing: Files never leave your browser
- Zero Tracking: No analytics or user behavior monitoring
- Content Security Policy: Protection against XSS attacks
- File Validation: Secure file type checking and processing
- Input Sanitization: All user inputs properly sanitized
- Local Encryption: Sensitive data encrypted in localStorage
We welcome contributions from developers of all skill levels!
- Fork the repository
- Create a feature branch:
git checkout -b feature/amazing-feature - Develop your feature with proper tests
- Commit with clear messages:
git commit -m 'Add amazing feature' - Push to your branch:
git push origin feature/amazing-feature - Open a Pull Request with detailed description
- ✅ TypeScript for all new code
- ✅ Follow existing code patterns and style
- ✅ Add proper error handling and logging
- ✅ Include JSDoc comments for functions
- ✅ Test functionality across different browsers
- ✅ Maintain responsive design principles
- 🐛 Bug fixes and performance improvements
- ✨ New features and enhancements
- 🌐 Translation and localization
- 📚 Documentation improvements
- 🎨 UI/UX enhancements
This project is released under a custom non-commercial license with the following terms:
- Personal Use: Individual, non-commercial use
- Educational Use: Academic and learning purposes
- Research: Non-commercial research projects
- Open Source Contributions: Community contributions welcome
- Code Study: Learning from the codebase
- Commercial Use: Any for-profit use without license
- Redistribution for Profit: Selling or monetizing the software
- Commercial Integration: Including in commercial products
- Service Offering: Offering as a paid service
- White-labeling: Rebranding for commercial use
For commercial use, enterprise licensing, or custom development:
Contact Author: aezizhu
- Email: [contact information]
- Business Inquiries: [business contact]
- Custom Development: Available for hire
Licensing Options:
- Enterprise License: Full commercial rights
- OEM License: Integration into products
- Custom Development: Tailored solutions
- Support Contracts: Professional support
Unauthorized commercial use constitutes copyright infringement and will result in:
- Immediate cease and desist demands
- Legal action for damages
- Potential criminal prosecution
- Public disclosure of violations
- Initial Load: < 2s on 3G connection
- Core Web Vitals: Excellent scores across all metrics
- Bundle Size: Optimized with code splitting
- Memory Usage: Efficient state management
- Browser Support: Modern browsers (ES2020+)
- Lazy Loading: Components loaded on demand
- Image Optimization: Next.js automatic optimization
- Caching Strategy: Efficient caching for better performance
- Code Splitting: Reduced initial bundle size
- Tree Shaking: Unused code elimination
- GitHub Discussions: Feature requests and community chat
- Issue Tracker: Bug reports and technical issues
- Wiki: Comprehensive documentation and guides
- Releases: Version history and changelog
- Next.js Team: Revolutionary React framework
- Vercel: Deployment and hosting platform
- Tailwind Labs: Beautiful utility-first CSS
- Mozilla: PDF.js rendering engine
- React Team: Component-based architecture
- Open Source Community: Inspiration and collaboration
- Beta Testers: Early feedback and bug reports
- Contributors: Code improvements and features
- Translators: Multi-language support
- 📚 Documentation: Comprehensive guides in
/docs - 🐛 Bug Reports: GitHub Issues with templates
- 💬 Discussions: Community Q&A and features
- 📧 Direct Support: Contact author for urgent issues
- ⭐ Star the repository for updates
- 👀 Watch for new releases and features
- 🍴 Fork to contribute or customize
- 📢 Share with your reading community
🚀 Built with passion by aezizhu
Revolutionizing digital reading, one feature at a time