Skip to content

๐ŸŒŸ Transform your monitor into an elite reading lamp - Modern PWA with glassmorphism UI, multiple reading modes, and eye-friendly lighting

License

Notifications You must be signed in to change notification settings

berkay-c/LuminousReader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

6 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŒŸ Luminous Reader

Version License PWA GitHub stars

Transform your monitor into an elite reading lamp

Modern, elegant, and eye-friendly reading experience

๐ŸŒ Live Demo โ€ข ๐Ÿ“– Documentation โ€ข ๐Ÿš€ Quick Start


๐Ÿ“ธ Demo Showcase

๐ŸŽฌ Interactive Demo

Experience all features in action! Click through the demo frames below to see the full functionality:

1. Main Interface

Main Interface Clean, modern interface with glassmorphism design and toggle panel

2. About Modal

About Modal Comprehensive developer information and project details

3. Install Panel

Install Panel Beautiful right-sliding PWA installation panel

4. Random Color Feature

Random Color One-click random color generation with dice button

5. Settings Modal

Settings Modal Complete settings panel with various options


โœจ Features

๐ŸŽจ Advanced Color Control

  • Custom Color Picker - Choose any color you prefer
  • Smart Preset Palettes - 6 optimized colors for different reading scenarios
  • Live Preview - See changes instantly as you adjust

๐Ÿ’ก Intelligent Brightness

  • Smooth Slider Control - 10-100% brightness with fluid transitions
  • Eye Strain Reduction - Automatic blue light filtering
  • Perfect for Any Environment - From bright rooms to complete darkness

๐Ÿ“š Smart Reading Modes

  • ๐Ÿ” Focus Mode - Bright white light for intense reading
  • ๐Ÿƒ Relax Mode - Soft cream light for comfortable reading
  • ๐ŸŒ™ Night Mode - Warm, dim light to preserve your sleep cycle
  • ๐Ÿ“– Study Mode - Balanced light optimized for learning

โšก Lightning Fast Controls

  • One-Touch Access - Quick controls for instant adjustments
  • Random Color Generator - Dice button for surprise colors
  • Panel Toggle - Hide/show controls with one click
  • Keyboard Shortcuts - Full keyboard navigation support
  • Smart Memory - Remembers your preferences automatically

๐Ÿ“ฑ Progressive Web App

  • Install Anywhere - Works on desktop, tablet, and mobile
  • Offline Ready - Service worker ensures reliability
  • Native Feel - Feels like a real app when installed

๐ŸŽจ Modern Design

  • Glassmorphism UI - Beautiful blur effects and transparency
  • Responsive Design - Perfect on any screen size
  • Smooth Animations - Delightful micro-interactions

๐Ÿš€ Quick Start

๐ŸŒ Try It Online

๐Ÿš€ Live Demo - Experience the app directly in your browser!

๐Ÿ’ป Local Development

# Clone the repository
git clone https://github.com/berkay-c/LuminousReader.git
cd LuminousReader

# Install dependencies (optional)
npm install

# Start development server
npm run dev
# or
npx live-server --port=3000

๐Ÿ“ฑ Install as PWA

  1. Open the app in your browser
  2. Click the Install button in the header (๐Ÿ“ฅ icon)
  3. Click "Install" in the popup to add to your home screen
  4. Enjoy native app experience!

๐Ÿ’ก Tip: The install prompt is now manually triggered for better user control!


๐ŸŽฎ How to Use

๐ŸŽฏ Basic Usage

  1. Choose Your Color - Use the color picker or select from presets
  2. Adjust Brightness - Drag the slider to your preferred level
  3. Select Reading Mode - Pick the mode that suits your activity
  4. Go Fullscreen - Press F for immersive experience
  5. Start Reading - Your monitor is now your personalized reading lamp!

โŒจ๏ธ Keyboard Shortcuts

Key Action
Space Toggle power on/off
F Toggle fullscreen mode
P Toggle control panel
R Random color selection

๐ŸŽจ Reading Modes Explained

  • ๐Ÿ” Focus Mode: Bright white light (100% brightness) - Perfect for intense reading, studying, or detailed work
  • ๐Ÿƒ Relax Mode: Soft cream light (60% brightness) - Ideal for casual reading and relaxation
  • ๐ŸŒ™ Night Mode: Warm amber light (30% brightness) - Reduces blue light for better sleep
  • ๐Ÿ“– Study Mode: Balanced light (80% brightness) - Optimized for learning and note-taking

๐Ÿ› ๏ธ Technologies

Technology Purpose
HTML5 Modern semantic structure
CSS3 Glassmorphism, animations, responsive design
JavaScript ES6+ Modern JavaScript features
PWA Service Worker, Manifest
Web APIs Local Storage, Fullscreen API

๐Ÿ“ Project Structure

LuminousReader/
โ”œโ”€โ”€ index.html              # Main HTML file
โ”œโ”€โ”€ README.md              # Project documentation
โ”œโ”€โ”€ LICENSE                # MIT license
โ”œโ”€โ”€ package.json           # Project configuration
โ”œโ”€โ”€ screenshots/           # App screenshots
โ”œโ”€โ”€ public/
โ”‚   โ””โ”€โ”€ manifest.json      # PWA manifest
โ””โ”€โ”€ src/
    โ”œโ”€โ”€ assets/
    โ”‚   โ”œโ”€โ”€ icons/         # SVG icons
    โ”‚   โ””โ”€โ”€ images/        # Logo and graphics
    โ”œโ”€โ”€ css/
    โ”‚   โ””โ”€โ”€ main.css       # Main stylesheet
    โ””โ”€โ”€ js/
        โ”œโ”€โ”€ app.js         # Main application logic
        โ””โ”€โ”€ sw.js          # Service worker

๐ŸŒŸ Key Benefits

๐Ÿ‘๏ธ Eye Health

  • Blue Light Reduction - Warm color options reduce eye strain
  • Adjustable Brightness - Perfect for any lighting condition
  • Smooth Transitions - No jarring changes that hurt your eyes

๐Ÿš€ Performance

  • Lightning Fast - Loads instantly, works offline
  • Minimal Resources - Uses less than 1MB of data
  • Cross-Platform - Works on any device with a browser

๐ŸŽจ User Experience

  • Intuitive Design - Easy to use for anyone
  • Beautiful Interface - Modern glassmorphism design
  • Responsive - Perfect on desktop, tablet, and mobile

๐Ÿค Contributing

We welcome contributions! Here's how you can help:

  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

๐Ÿ› Bug Reports

Found a bug? Please open an issue with:

  • Description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Browser and device information

๐Ÿ’ก Feature Requests

Have an idea? We'd love to hear it! Create an issue with:

  • Clear description of the feature
  • Why it would be useful
  • Any mockups or examples

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.


๐Ÿ“ž Contact

Berkay ร‡iftรงi - Software & RPA Developer

GitHub Email


Transform your reading experience with Luminous Reader! ๐ŸŒŸ

Made with โค๏ธ by Berkay ร‡iftรงi

โฌ† Back to Top

About

๐ŸŒŸ Transform your monitor into an elite reading lamp - Modern PWA with glassmorphism UI, multiple reading modes, and eye-friendly lighting

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published