Skip to content

hansakoch/rosari-org

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

14 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

โœ๏ธRosari๐Ÿ“ฟ โ€” A Modern Rosary Web App๐Ÿ™

A beautiful, fully-featured Progressive Web App (PWA) for praying the rosary with authentic Latin prayers, intelligent text-to-speech, and a seamless cross-platform experience.

โœจ Features

  • ๐Ÿ“ฟ Latin Prayers โ€” Complete rosary prayers in Latin with proper liturgical structure
  • ๐ŸŽค AI Voice โ€” xAI WebSocket Voice API for natural, expressive audio narration with gender selection
  • ๐Ÿ”Š Ambient Audio โ€” Gentle ambient audio accompaniment with customizable volume
  • ๐Ÿ’พ Smart Caching โ€” KV cache-first TTS system minimizes API usage and costs
  • ๐ŸŽต Karaoke Mode โ€” Follow along with prayer text synchronized to audio
  • ๐Ÿ“… Liturgical Seasons โ€” Dynamically adapts prayers based on the liturgical calendar
  • ๐ŸŒ Full-Screen Design โ€” Immersive, distraction-free prayer interface
  • ๐Ÿ“ฑ Mobile First โ€” Optimized for iOS, Android, and all modern browsers
  • โšก Offline Ready โ€” Works as a PWA with offline capabilities
  • โ™ฟ Accessible โ€” WCAG-compliant with proper semantic HTML and ARIA labels
  • ๐Ÿš€ Fast โ€” Built with Astro 5 for optimal performance and instant load times

๐Ÿ› ๏ธ Tech Stack

  • Astro 5 โ€” Static site generation with partial hydration
  • Cloudflare Workers โ€” Serverless edge computing
  • Cloudflare KV โ€” Distributed caching for TTS results
  • xAI Voice API โ€” Advanced text-to-speech with natural voice synthesis
  • TypeScript โ€” Type-safe JavaScript
  • PWA โ€” Progressive Web App standards

๐Ÿ“ฆ Installation

# Clone the repository
git clone https://github.com/hansakoch/rosari-org.git
cd rosari-org

# Install dependencies
npm install

# Set up environment variables
cp .dev.vars.template .dev.vars
# Edit .dev.vars with your xAI API key and other configuration

๐Ÿš€ Development

# Start local development server
npm run dev

# Build for production
npm run build

# Generate Cloudflare types
npm run cf-typegen

๐Ÿš€ Deployment

Deploy to Cloudflare Workers:

npm run deploy

The app will be deployed to your Cloudflare account with all bindings (KV storage, environment variables) configured.

๐Ÿ”ง Configuration

Create a .dev.vars file based on .dev.vars.template with the following:

  • XAI_API_KEY โ€” Your xAI API key for Voice API access
  • KV_NAMESPACE_ID โ€” Cloudflare KV namespace ID for TTS caching
  • Other environment-specific settings

๐Ÿ“– Project Structure

src/
โ”œโ”€โ”€ pages/           # Astro pages and routes
โ”œโ”€โ”€ components/      # Reusable UI components
โ”œโ”€โ”€ layouts/         # Page layouts
โ”œโ”€โ”€ api/            # API endpoints for KV caching, TTS processing
โ”œโ”€โ”€ styles/         # Global styles and theme
โ””โ”€โ”€ utils/          # Helper functions, prayer data

๐Ÿ“œ License

This project is open source and licensed under the MIT License โ€” free for anyone to download, use, modify, and distribute. See LICENSE for details.

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit issues and pull requests to improve the app.

๐Ÿ™Œ Acknowledgments

  • Built with Astro
  • Powered by xAI for voice synthesis
  • Hosted on Cloudflare
  • Prayer texts sourced from traditional Roman Catholic liturgical sources

Made with โค๏ธ for the faithful.

About

โœ๏ธRosari๐Ÿ“ฟโ€” A Modern Rosary Web App๐Ÿ™

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors