Skip to content

ramybenaroya/shreado

Repository files navigation

Shreado

A speed reading app built with Next.js that uses RSVP (Rapid Serial Visual Presentation) technology to help you read faster. Train your brain to read up to 3x faster.

Features

  • Speed Reader - RSVP-based reading with customizable speed (100-1000+ WPM)
  • Multiple Reading Modes - Different display modes for various preferences
  • File Support - Upload PDF, DOCX, or TXT files
  • Keyboard Shortcuts - Control playback with Space, arrow keys
  • Customizable - Adjust font size, colors, and more

Getting Started

Development

npm install
npm run dev

Open http://localhost:3000 with your browser.

Keyboard Shortcuts

  • Space - Play/Pause
  • / - Previous/Next word
  • / - Increase/Decrease speed

Deployment

Deploy to Cloudflare Workers

This project is configured for deployment to Cloudflare Workers using the OpenNext adapter.

Prerequisites

  1. A Cloudflare account
  2. Wrangler CLI (included as dev dependency)

Local Preview (Workers Runtime)

Test your app in the Cloudflare Workers runtime locally:

npm run preview

Build for Cloudflare

npm run build:cf

Deploy

npm run deploy

This will deploy your app to shreado.<your-subdomain>.workers.dev.

Custom Domain

To use a custom domain, configure it in the Cloudflare dashboard under Workers & Pages > your worker > Settings > Domains & Routes.

Deploy to Vercel

Alternatively, deploy to Vercel:

Deploy with Vercel

Project Structure

shreado/
├── app/                 # Next.js App Router
│   ├── page.tsx         # Main page
│   ├── layout.tsx       # Root layout
│   └── globals.css      # Global styles
├── components/          # React components
│   ├── RSVPReader.tsx   # Main reader component
│   ├── TextInput.tsx    # Text input/upload
│   ├── Settings.tsx     # Settings panel
│   └── ...
├── lib/                 # Utility functions
│   ├── file-parser.ts   # PDF/DOCX/TXT parsing
│   ├── text-processor.ts
│   └── rsvp-engine.ts
├── types/               # TypeScript types
├── wrangler.jsonc       # Cloudflare Workers config
└── next.config.ts       # Next.js config

Tech Stack

Learn More

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors