README.md
to include detailed project overview, features breakdown, technical stack, usage guide, project structure, and educational context for improved clarity and documentation quality.
Signed-off-by: Matthias Puchstein <matthias@puchstein.bayern>
REMind - Dream Analysis & VR Experience Platform
🚧 IMPORTANT: This is a MOCKUP/DEMO APPLICATION for a university project
No real backend, AI features, or data storage. All functionality is simulated for demonstration purposes.
Project Overview
REMind is an innovative interactive prototype that explores the intersection of dream analysis, artificial intelligence, and virtual reality. The application demonstrates how modern technology could revolutionize dream journaling and interpretation through immersive experiences and intelligent analysis.
Project Aim: To showcase the potential of combining dream journaling with AI-powered analysis and VR visualization, creating an engaging platform for understanding the subconscious mind and exploring the societal implications of dream research.
✨ Key Features
🌙 Multi-Modal Dream Recording
- Text Input: Write detailed dream descriptions with rich formatting
- Voice Recording: Record dream narratives with audio transcription
- Image Upload: Upload dream sketches, drawings, or related images
- Biometric Integration: Simulate EEG, heart rate, and movement data from sleep tracking devices
🤖 AI-Powered Analysis (Simulated)
- Symbol Recognition: Identify and categorize dream symbols
- Emotion Detection: Analyze emotional patterns and mood indicators
- Interpretation Engine: Generate personalized dream interpretations
- Pattern Analysis: Detect recurring themes and symbols across dreams
🎮 VR Dreamscapes
- 3D Visualization: Transform dreams into immersive 3D environments
- Neural Network Visualization: Interactive neural network representations for biometric data
- VR Experience: WebXR-enabled virtual reality exploration
- Responsive Controls: Support for both VR headsets and desktop interaction
📊 Advanced Analytics
- EEG Visualization: Real-time brainwave pattern charts (Alpha, Beta, Theta, Delta)
- Vital Signs Monitoring: Heart rate and HRV trend analysis
- Movement Tracking: Sleep movement pattern visualization
- Statistical Dashboard: Comprehensive dream pattern analysis
🗂️ Dream Archive & Management
- Personal Library: Organized collection of all dream entries
- Search & Filter: Advanced filtering by date, symbols, emotions, and tags
- Social Features: Share dreams with friends and community
- Daily Highlights: Curated dream insights and patterns
🌐 Community Features
- Dream Archive: Explore categorized dream collections
- Research Integration: Live research data visualization
- Cultural Landscapes: Dreams categorized by cultural themes
- Worldwide Events: Global dream pattern analysis
🛠️ Technology Stack
Frontend Framework
- React 19.1.0 - Modern React with latest features
- TypeScript - Type-safe development
- Vite 7.0.0 - Fast build tool and development server
Styling & UI
- Tailwind CSS 4.1.11 - Utility-first CSS framework
- CSS Variables - Dynamic theming system
- Responsive Design - Mobile-first approach
3D & VR
- Three.js 0.178.0 - 3D graphics library
- @react-three/fiber 9.2.0 - React Three.js renderer
- @react-three/drei 10.5.1 - Three.js helpers
- @react-three/xr 6.6.19 - WebXR integration
- webxr-polyfill 2.0.3 - VR compatibility
Data Visualization
- D3.js 7.9.0 - Advanced data visualization
- Custom Chart Components - EEG, vitals, and movement charts
Navigation & Routing
- React Router DOM 7.6.3 - Client-side routing
- React Icons 5.5.0 - Comprehensive icon library
Development Tools
- ESLint - Code linting and formatting
- TypeScript ESLint - TypeScript-specific linting
- Vite Plugin React - React integration
📁 Project Structure
REMind/
├── public/ # Static assets (favicon, etc.)
├── src/
│ ├── assets/ # Images, logos, fonts
│ ├── components/ # Reusable UI components
│ │ ├── DreamCard.tsx # Dream display component
│ │ ├── DreamRecord.tsx # Dream recording interface
│ │ ├── DreamVR.tsx # VR visualization component
│ │ ├── DreamCharts.tsx # Data visualization components
│ │ ├── Navbar.tsx # Navigation component
│ │ └── ...
│ ├── data/ # Mock data for demonstration
│ │ ├── MockDreams.ts # Sample dream entries
│ │ ├── MockUsers.ts # User data
│ │ └── ...
│ ├── pages/ # Route-driven page components
│ │ ├── Home.tsx # Main dashboard
│ │ ├── Feed.tsx # Dream feed
│ │ ├── DreamPage.tsx # Individual dream view
│ │ ├── Overview.tsx # Landing page
│ │ └── dreamarchive/ # Archive pages
│ ├── types/ # TypeScript type definitions
│ │ ├── Dream.ts # Dream data structures
│ │ └── User.ts # User data structures
│ ├── utils/ # Utility functions
│ ├── styles/ # Styling utilities
│ ├── App.tsx # Root component
│ ├── main.tsx # Application entry point
│ └── index.css # Global styles
├── docs/ # Documentation
│ └── poster.pdf # Project presentation poster
├── package.json # Dependencies and scripts
├── tsconfig.app.json # TypeScript configuration
├── vite.config.ts # Vite configuration
└── README.md # This file
🚀 Getting Started
Prerequisites
- Node.js 18+
- npm or yarn package manager
Installation
-
Clone the repository
git clone https://gitea.puchstein.bayern/mpuchstein/REMind.git cd REMind
-
Install dependencies
npm install
-
Start development server
npm run dev
-
Open in browser
http://localhost:5173
Available Scripts
npm run dev
- Start development servernpm run build
- Build for productionnpm run preview
- Preview production buildnpm run lint
- Run ESLint
🎯 Usage Guide
Getting Started
- Landing Page: Visit the overview page to understand the application concept
- Begin Journey: Click "Lass die Magie beginnen" to start the dream recording experience
- Record Dreams: Use various input methods (text, voice, image, biometric)
- AI Analysis: View simulated AI interpretations and insights
- VR Experience: Explore dreams in virtual reality environments
- Archive Exploration: Browse and filter through dream collections
Key Navigation
- Home (
/home
) - Personal dashboard with recent dreams - Feed (
/feed
) - Community dream sharing - Record (
/record
) - Dream input interface - Dream Archive (
/dreamarchive
) - Categorized dream collections - Profile (
/profile
) - User settings and statistics
Input Types
- Text: Write detailed dream descriptions
- Audio: Record voice memos with transcription
- Image: Upload dream-related visuals
- Chip: Biometric data from sleep tracking devices
🔮 Demo Features
Simulated AI Analysis
- Symbol Recognition: Identifies dream symbols like "water," "flying," "animals"
- Emotion Tagging: Categorizes emotions as "fear," "joy," "anxiety," "peace"
- Interpretation: Generates psychological insights and meanings
- Pattern Detection: Highlights recurring themes across dreams
VR Visualization
- Neural Networks: Interactive 3D representations of brain activity
- Dreamscapes: Immersive environments based on dream content
- Data Visualization: 3D charts and graphs for biometric data
- WebXR Support: Compatible with VR headsets and desktop browsers
Data Analytics
- EEG Patterns: Brainwave analysis during sleep (Alpha, Beta, Theta, Delta)
- Vital Signs: Heart rate and heart rate variability trends
- Movement Data: Sleep movement and restlessness patterns
- Statistical Insights: Long-term pattern analysis and correlations
⚠️ Important Notes
Assets Not Included
- Media Files: Dream images, audio files, and videos are not included in the repository
- Mock Data: All displayed content uses placeholder data for demonstration
- External Resources: Some images and media are referenced but not stored in the repository
Limitations
- No Backend: All data is stored locally in browser memory
- No AI Integration: Analysis results are pre-generated mock responses
- No Data Persistence: Data is lost when browser is refreshed
- Demo Purpose Only: Not intended for production use
🎓 Educational Context
This project was developed as a university demonstration to explore:
- Human-Computer Interaction: Innovative interfaces for dream recording
- Data Visualization: Advanced techniques for complex data representation
- Virtual Reality: Immersive experiences for psychological content
- AI Integration: Simulated machine learning for content analysis
- User Experience: Intuitive design for sensitive personal data
🤝 Contributing
This is a university project demo and not actively maintained for production use. However, feedback and suggestions are welcome for educational purposes.
📄 License
This project is licensed under the AGPL-3.0 License - see the LICENSE file for details.
🔗 Repository
Disclaimer: REMind is a prototype demonstration created for educational purposes. All AI features, data analysis, and interpretations are simulated and should not be used for actual psychological or medical analysis.