From 74707829fe8f37ea304717a4bb692ca1f1b5560c Mon Sep 17 00:00:00 2001
From: Matthias Puchstein <matthias@puchstein.bayern>
Date: Sat, 5 Jul 2025 00:57:00 +0200
Subject: [PATCH] added a better README

---
 README.md | 140 ++++++++++++++++++++++++++++++------------------------
 1 file changed, 79 insertions(+), 61 deletions(-)

diff --git a/README.md b/README.md
index b7c71fb..39e06a4 100644
--- a/README.md
+++ b/README.md
@@ -1,74 +1,92 @@
-<<<<<<< HEAD
-# REMind
+<img src="https://r2cdn.perplexity.ai/pplx-full-logo-primary-dark%402x.png" class="logo" width="120"/>
 
-=======
-# React + TypeScript + Vite
+# REMind (Mockup Demo)
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+🚧 **This is a MOCKUP / DEMO APPLICATION for a university project – no real backend, AI features, or data storage.** 🚧
 
-Currently, two official plugins are available:
+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.
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+## Features (all mockup/demo only)
 
-## Expanding the ESLint configuration
+- **(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.
 
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+## Tech Stack
 
-```js
-export default tseslint.config([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
+- **Framework:** React + TypeScript
+- **Bundler:** Vite
+- **Styling:** Tailwind CSS
+- **Routing:** React Router Dom
+- **Icons:** React Icons
+- **3D \& VR:** @react-three/fiber
+- **Linting:** ESLint
 
-      // Remove tseslint.configs.recommended and replace with this
-      ...tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      ...tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      ...tseslint.configs.stylisticTypeChecked,
+## Getting Started
 
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+> **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
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+2. Install dependencies
 
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default tseslint.config([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+```bash
+npm install
 ```
->>>>>>> 4908392 (initial)
+
+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!