A calm, astro-themed productivity app designed for neurodivergent users. Manage routines, tasks, habits, notes, and stats with Markdown import/export, reminders, gamification, and secure local/mobile use.
- Progressive Web App (PWA): Install on any device, works offline
- Routines: Create, edit, and run daily routines with timers. Create routines from templates via an integrated library modal
- Tasks: Prioritise using the Eisenhower matrix
- Template Library: 13+ predefined task and routine templates to get started quickly. Access from Settings or inline when creating routines
- Habits: Track streaks and small wins
- Notes & Brain Dump: Markdown-ready with comprehensive import/export (
.jsonfor full backup,.mdfor content only) - Stats Foundation: Track routine time and structured progress with IndexedDB
- Auto-Backup: Automatic backups every 24 hours to prevent data loss
- IndexedDB Storage: Fast, reliable structured data storage (up to 50MB+)
- File Attachments: OPFS support for attaching files to notes
- Gamification (v2.0+): XP, levels, achievements, confetti/haptics
- Reminders (v2.0+): Tasks, routines, and habits notifications
- Secure by design: Strict CSP, modular code, no inline scripts
- Multi-mode builds: Android packaging, offline desktop distribution, and online web deployment
See the ROADMAP.md for detailed milestones (Alpha, Beta, v1.0, v2.0, and beyond).
-
Clone the repository:
git clone https://github.com/ayanimea/aurorae-haven.git cd aurorae-haven -
Install dependencies:
npm install
-
Start the Vite development server:
npm run dev
The app will open at
http://localhost:3000 -
Build for production:
npm run build
The production build will be in the
dist/directory -
Test the production build locally:
npm run preview
This will start a local server to preview the production build
Aurorae Haven is now a Progressive Web App! You can install it on your device:
- Visit the app in a modern browser (Chrome, Firefox, Edge, Safari)
- Look for the "Install" or "Add to Home Screen" prompt
- Click install to add the app to your device
- Launch from your home screen or app drawer
Benefits: Works offline, faster loading, native app experience
Download the full website for offline use without build tools!
-
Go to the GitHub Actions page
-
Click on the latest successful workflow run
-
Scroll down to "Artifacts" section
-
Download
offline-package -
Extract the
.tar.gzfile:tar -xzf aurorae-haven-offline-*.tar.gz -
Double-click
index.htmlto open in your browser - no server needed!# Optional: Serve with a local server for PWA installation python3 -m http.server 8000
What's included: Complete static website with all assets, service worker, and PWA manifest. Built with relative paths so it works directly from your file system!
-
Dependencies:
- Node.js 14+ (for building)
- Modern browser (Chrome, Firefox, Edge, Safari)
-
Build Instructions:
npm install npm run build npm run preview # Preview production build locally -
Install Methods:
- ✅ Progressive Web App (PWA) installation
- ✅ Offline desktop package (
npm run build:mode:desktop) - ✅ Android packaging flow (
npm run build:mode:android+npm run package:android) - ✅ Online web deployment (
npm run build:mode:web+ Docker)
- IndexedDB: Primary storage for structured data (tasks, habits, schedules, stats)
- OPFS: File attachments with metadata references in IndexedDB
- localStorage: Fallback and UI state (brain dump content, tags, version history)
- Automatic Backups: Daily backups stored in IndexedDB (keeps last 10)
- ✅ Export: Download all data as JSON file with timestamp and UUID
- ✅ Import: Restore from any previous export with validation
- ✅ Auto-Migration: Automatic migration from localStorage to IndexedDB
- ✅ Backward Compatible: Works with both old and new storage systems
- localStorage: ~5-10 MB (fallback)
- IndexedDB: ~50 MB+ (primary, varies by browser)
- OPFS: Limited by available disk space
See the User Manual for complete documentation on features and usage.
- Progressive Web App (PWA): Installable, offline-capable, app-like experience
- ReactJS: Modular component-based architecture for maintainability
- HTML5 & CSS: Modern web standards with responsive design
- IndexedDB: Structured data storage with indexes and transactions
- OPFS: File system access for attachments
- Service Worker: Enables offline functionality and caching strategies
- Web Manifest: Provides app metadata for installation
- Modular Components: Organized codebase with clear separation of concerns
The app is automatically deployed to GitHub Pages when changes are pushed to main, feature-*, or hotfix-* branches.
The deployment workflow:
- Runs tests and security audits
- Installs Node.js dependencies
- Builds the React application with Vite (
npm run build) - Automatically generates PWA assets (service worker, manifest, icons) via vite-plugin-pwa
- Deploys to GitHub Pages
Build Tool: Vite (fast, modern bundler with HMR)
Live URL: https://aurorae-haven.github.io/aurorae-haven/
- Strict Content Security Policy (CSP): No inline scripts or styles
- No external dependencies: All resources served locally or with SRI
- No tracking: Your data never leaves your device
- Local-only storage: IndexedDB + OPFS, all data stays on your device
- Export anytime: JSON export for backup and migration
- Open source: Auditable codebase
- Automatic backups: Daily backups to prevent data loss
- Regular audits: Security scanning and vulnerability checks
- User Manual: Complete guide to LaTeX equations, images, and markdown formatting
- Notes Usage Guide: Feature walkthrough and examples
- Export/Import: Use the Settings page to export your data as JSON for backup or migration
- Automatic Backups: Daily backups stored locally in IndexedDB
- Storage: All data stored locally on your device using IndexedDB and OPFS
- Future server schema: PostgreSQL account-scoped design draft
- Optional backend integration draft: Backend integration requirements (for future/custom sync work; local-first app works without backend auth)
- Notes Specifications: Technical details about Notes features
- Tasks Specifications: Technical details about Tasks and Eisenhower Matrix
- Roadmap: Development milestones and future plans
- Contributing Guide: How to contribute to the project
- Compilation Modes: Android, offline desktop, and online web setup guide
Contributions, feedback, and ideas are welcome!
Want to contribute task or routine templates? We welcome community contributions!
- Templates are stored in
src/data/templates/as JSON files - 13+ predefined templates already included to help users get started
- Easy to add: just follow the schema in existing templates, test locally, and submit a PR
- See the template files in
src/data/templates/for examples