Skip to content

fihtony/readingstar-planet

Repository files navigation

ReadingStar Planet

ReadingStar Planet is a Next.js reading support app designed for children who benefit from structured, low-friction reading assistance. It combines reading focus tools, text-to-speech support, document management, and role-based administration in a single web app.

Features

  • Guided reading modes with adjustable font size, line spacing, masking, and themed focus views
  • Text-to-speech support with voice preview and reading companion controls
  • PDF, TXT, and pasted-text import flows with preview and editing before saving
  • Library management with document grouping, search, sorting, editing, and reading history
  • Role-aware account management, profile editing, and admin-only global defaults
  • English and Chinese UI support, plus PWA support for an app-like experience

Screenshots

Homepage

An inviting entry point into the ReadingStar planet adventure.

Reading Star Planet Homepage

Spotlight Reading

Keep the paragraph focused by highlighting a chosen character.

Spotlight Reading Mode

Letter Detective

Practice spotting letters that are easy to confuse.

Letter Detective Game

Tech Stack

  • Next.js App Router
  • React + TypeScript
  • Tailwind CSS
  • SQLite via better-sqlite3
  • Vitest and Playwright for testing

How To Run

Requirements

  • Node.js 22+
  • npm

Install

npm install

Development

npm run dev

Open http://localhost:3000.

Production Build

npm run build
npm start

Tests

npm test

For end-to-end coverage:

npm run test:e2e

Environment Notes

  • Google sign-in is optional and requires local environment variables such as GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET, and GOOGLE_REDIRECT_URI.
  • The SQLite database is created locally under data/ by default, or you can override the location with READINGSTAR_DB_PATH.
  • You can seed an initial admin account with INITIAL_ADMIN_EMAIL.

License

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

About

ReadingStar Planet is a reading support app designed for children who benefit from structured, low-friction reading assistance.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages