91 lines
3.2 KiB
Markdown
91 lines
3.2 KiB
Markdown
# REMind (Mockup Demo)
|
||
|
||
🚧 **This is a MOCKUP / DEMO APPLICATION for a university project – no real backend, AI features, or data storage.** 🚧
|
||
|
||
REMind is an interactive, front-end prototype that showcases dream journaling, AI-powered analysis (simulated), and immersive VR demonstrations. Built with React, TypeScript, Vite, and Tailwind CSS, it’s designed for demos and concept validation only.
|
||
|
||
## Features (all mockup/demo only)
|
||
|
||
- **(Mockup)** Dream Journal
|
||
Record dreams as text entries, voice memos, or sketches—UI only, no persistence.
|
||
- **(Mockup)** AI Analysis
|
||
Simulated “Here the AI would analyze your dream…” step with instant, hard-coded interpretations, symbol recognition, and emotion tagging.
|
||
- **(Mockup)** Personal Archive
|
||
Browse and filter past mock entries by date, symbols, emotions, or tags.
|
||
- **(Mockup)** Statistics \& Trends
|
||
Visualize frequent symbols, emotional patterns, and simulated sleep-cycle correlations using dummy data.
|
||
- **(Mockup)** VR Dreamscapes
|
||
Enter 3D scenes built with React Three Fiber—explore thematic environments (labyrinths, dark rooms) in browser-based VR mode.
|
||
- **Responsive Design**
|
||
Works on desktop browsers(design optimized for mobile) and mobile devices. Ideal for QR-code launches at demos.
|
||
|
||
## Tech Stack
|
||
|
||
- **Framework:** React + TypeScript
|
||
- **Bundler:** Vite
|
||
- **Styling:** Tailwind CSS
|
||
- **Routing:** React Router Dom
|
||
- **Icons:** React Icons
|
||
- **3D \& VR:** @react-three/fiber
|
||
- **Linting:** ESLint
|
||
|
||
## Getting Started
|
||
|
||
> **Note:** This repository contains only a front-end prototype with hard-coded mock data. There is no production backend or AI service.
|
||
|
||
1. Clone the repo
|
||
|
||
```bash
|
||
git clone https://gitea.puchstein.bayern/mpuchstein/REMind.git
|
||
cd REMind
|
||
```
|
||
|
||
2. Install dependencies
|
||
|
||
```bash
|
||
npm install
|
||
```
|
||
|
||
3. Run development server
|
||
|
||
```bash
|
||
npm run dev
|
||
```
|
||
|
||
Open `http://localhost:5173` in your browser. 4. Build for production (static demo)
|
||
|
||
```bash
|
||
npm run build
|
||
npm run preview
|
||
```
|
||
|
||
## Project Structure
|
||
|
||
```
|
||
.
|
||
├── public/ # Static assets
|
||
├── src/
|
||
│ ├── assets/ # Images, fonts
|
||
│ ├── components/ # Reusable React components
|
||
│ ├── data/ # Mock data (dream entries, analysis)
|
||
│ ├── pages/ # Route-driven pages
|
||
│ ├── types/ # TypeScript types/interfaces
|
||
│ ├── App.tsx # Root component
|
||
│ ├── index.css # Tailwind setup
|
||
│ └── main.tsx # Entry point
|
||
├── index.html # HTML template
|
||
├── package.json # Scripts & dependencies
|
||
├── tsconfig.app.json # TS config for app
|
||
├── vite.config.ts # Vite config
|
||
└── README.md # This file
|
||
```
|
||
|
||
## Usage \& Demo
|
||
|
||
- **Start Dream Journal** — click “🌙 Lass die Magie beginnen” to open the mock dream entry form.
|
||
- **AI Analysis** — submit an entry to see the “mock” interpretation card.
|
||
- **Browse Archive** — filter mock entries by symbol, emotion, or date.
|
||
- **VR Mode** — click VR Demo to load an immersive 3D scene in your browser.
|
||
|
||
**Reminder:** REMind is a design-and-concept prototype only. Enjoy exploring the features—no real data or AI integration under the hood!
|