Francesco Laiti commited on
Commit
37de0c2
·
1 Parent(s): 9793f25

Update README

Browse files
Files changed (1) hide show
  1. README.md +61 -1
README.md CHANGED
@@ -8,9 +8,69 @@ pinned: true
8
  license: gpl-3.0
9
  ---
10
 
11
- # QuietRoom
 
12
 
13
  A privacy-first, multimodal journaling webapp that helps you capture and reflect on your daily experiences through photos, videos, audio recordings, text, and location data. QuietRoom leverages AI models to provide intelligent insights while maintaining your privacy.
14
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
15
  ## Disclaimer
16
  QuietRoom has been developed exclusively as a proof-of-concept for the "Google - The Gemma 3n Impact Challenge". It is not intended for use as a medical or therapeutic tool.
 
8
  license: gpl-3.0
9
  ---
10
 
11
+ # QuietRoom
12
+ ### Your thoughts, your device. Period.
13
 
14
  A privacy-first, multimodal journaling webapp that helps you capture and reflect on your daily experiences through photos, videos, audio recordings, text, and location data. QuietRoom leverages AI models to provide intelligent insights while maintaining your privacy.
15
 
16
+ # Run locally
17
+
18
+ ## Prerequisites
19
+ - Docker
20
+ - For serving the Gemma3n model:
21
+ - A Google API key if you have old hardware like me
22
+ - Or Ollama installed and served locally on port 11434
23
+ - Select the appropriate Gemma3n model in Settings
24
+
25
+ ## Using Docker
26
+
27
+ 1. **Build the Docker image:**
28
+ ```bash
29
+ docker build -t quietroom .
30
+ ```
31
+
32
+ 2. **Run the container:**
33
+ ```bash
34
+ docker run -p 7860:7860 quietroom
35
+ ```
36
+
37
+ 3. **Access the application:**
38
+ Open your browser and navigate to `http://localhost:7860`
39
+
40
+ The Dockerfile automatically:
41
+ - Sets up both Python backend and Node.js frontend environments
42
+ - Installs all dependencies
43
+ - Builds the frontend and serves it through the backend
44
+ - Exposes the application on port 7860
45
+
46
+ ## Development Setup
47
+
48
+ For development with live reloading, you may want to run the backend and frontend separately:
49
+
50
+ ### Backend
51
+ ```bash
52
+ cd backend
53
+ pip install -r requirements.txt # or uv sync
54
+ uvicorn app.main:app --reload --host 0.0.0.0 --port 7860
55
+ ```
56
+
57
+ ### Frontend
58
+ ```bash
59
+ cd frontend
60
+ npm install
61
+ npm run dev
62
+ ```
63
+
64
+ ## How to cite
65
+ If you find this work interesting and you are using part or full code of it, please cite me:
66
+
67
+ @misc{laitifranz_quietroom,
68
+ author = "Francesco {Laiti}",
69
+ title = "QuietRoom | Your thoughts, your device. Period.",
70
+ url = "https://huggingface.co/spaces/laitifranz/QuietRoom",
71
+ version = 0.1.0
72
+ year = 2025
73
+ }
74
+
75
  ## Disclaimer
76
  QuietRoom has been developed exclusively as a proof-of-concept for the "Google - The Gemma 3n Impact Challenge". It is not intended for use as a medical or therapeutic tool.