You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
DDFR is not just a computer vision system; it is a digital companion designed to restore confidence to those living with dementia. Thanks to advanced technology, the system recognizes the faces of friends and relatives in real-time, discreetly whispering to the patient who is in front of them and recalling past conversations. DDFR transforms uncertainty into familiarity, helping to keep the most precious bonds alive day after day.
27
+
Memory is the quiet thread that weaves the tapestry of our identity. When that thread begins to fray, the world can become a fragmented, uncertain place. DDFR is not merely a computer vision system; it is a digital anchor designed to restore confidence and dignity to those living with dementia.
28
+
29
+
Leveraging a sophisticated modular architecture, DDFR acts as an external memory extension. It perceives the environment in real-time, identifying the faces of loved ones—friends, family, caregivers—and discreetly bridges the cognitive gap. Currently, the system provides immediate visual identification, transforming the anxiety of the unknown into the comfort of familiarity. It is technology stepping back to let humanity come forward, helping to keep the most precious bonds alive.
31
30
32
31
## Technologies
33
32
@@ -36,44 +35,83 @@ DDFR is built on a modern and modular architecture, designed to ensure real-time
36
35
### Frontend & User Experience
37
36
The user interface is developed to be accessible, clear, and immediate.
38
37
39
-
***React:** Used to create a reactive and fluid Single Page Application (SPA). The visual component is optimized to ensure readability and ease of use, essential factors for the target audience.
38
+
***React:** Used to create a reactive and fluid Single Page Application (SPA). The visual component is optimized to ensure readability and ease of use.
40
39
***npm:** Manages the dependency ecosystem, ensuring a stable and up-to-date development environment.
41
40
42
41
### Backend & Core Performance
43
42
The heart of the system is a robust backend that handles high-speed data flow.
44
43
45
44
***Python:** The reference language for data processing and artificial intelligence.
46
-
***FastAPI:** Chosen for its exceptional performance and ability to handle asynchronous operations. It provides the REST APIs that connect the system's eye (the camera) to the brain (the server) and the user interface.
47
-
***Uvicorn:** The "lightning-fast" ASGI server that keeps the system online and responsive, handling multiple requests without perceptible latency.
45
+
***FastAPI:** Chosen for its exceptional performance. It provides the REST APIs that connect the system's eye (the camera) to the brain (the server).
46
+
***Uvicorn:** The ASGI server that keeps the system online and responsive, handling multiple requests without perceptible latency.
48
47
49
48
### Database & Data Storage
50
49
The system's long-term memory, essential for flexible data storage.
51
50
52
-
***MongoDB:** A document-oriented NoSQL database. It was chosen for its scalability and flexibility in managing complex data structures, such as relative registries, biometric vectors for facial recognition, and future conversation logs.
51
+
***MongoDB:** A document-oriented NoSQL databasechosen for its scalability in managing complex data structures, such as relative registriesand biometric vectors.
53
52
54
53
### Computer Vision (AI)
55
-
***Face Recognition (Python Lib):** The biometric recognition engine. This library, an industry standard for precision and simplicity, maps and identifies known faces (friends and relatives) with a high degree of reliability, ensuring recognition even in variable conditions.
54
+
***Face Recognition (Python Lib):** The biometric recognition engine. This librarymaps and identifies known faces with a high degree of reliability.
Setting up DDFR involves preparing the environment where the digital memory will reside. The process is automated to ensure all dependencies—from the visual cortex to the database connection—are correctly aligned.
60
59
61
-
</div>
60
+
### 1. Prerequisite Automation
61
+
We have prepared automated scripts to handle the installation of the necessary libraries and system requirements.
62
+
63
+
***Windows:** Execute `setup.bat`
64
+
***Linux/MacOS:** Execute `setup.sh`
65
+
66
+
### 2. Configuration
67
+
Before the system can breathe, it requires configuration. DDFR relies on specific environment variables to manage secure connections and database access.
68
+
69
+
**Backend Configuration**
70
+
Please refer to the technical documentation for the Python environment setup: [Config Documentation](https://fdemusso.github.io/DDFR/config/config/)
Create a `.env.development.local` file in the frontend directory. This establishes the secure link (HTTPS) required for webcam access and defines the WebSocket protocol for real-time communication.
Distributed under the *GPLv3* license. See `LICENSE` for more information.
86
+
*Note: Ensure your SSL certificates are generated and placed correctly to allow the browser to trust the local camera stream.*
71
87
88
+
##UsageOnce the environment is prepared, the system must be awakened manually. The architecture requires the simultaneous operation of the brain (backend) and the eyes (frontend).
89
+
90
+
###Awakening the System1. **Start the Database:** Ensure your MongoDB instance is running locally.
91
+
2.**Start the Brain:** In your terminal, navigate to the backend directory and launch the secure server:
92
+
```bash
93
+
python main.py https
94
+
```
72
95
73
-
### Developer Notes (not for public)
74
-
To start the local database server:
75
96
97
+
3.**Open the Eyes:** In a separate terminal, launch the user interface:
###The ExperienceUpon launching, the browser will request permission to access the webcam. This is the moment the system begins to observe. Currently, the recognition data—the faces of relatives and friends—must be manually curated in the database (admin phase).
105
+
106
+
When a known face appears before the camera, DDFR processes the biometric data and provides immediate text-based feedback on the screen, identifying the person. This text is the precursor to the upcoming "human-like" text-to-speech engine.
107
+
108
+
##ContributingWe are currently in the phase of solidifying the foundation. The core logic for recognition is complete, and we are not looking for new feature implementations at this moment.
109
+
110
+
Our primary need is for **Testers** and **Code Reviewers**.
111
+
112
+
***Code Review:** We need architects to review the codebase for cleanliness, order, and adherence to best practices.
113
+
***Testing:** Verification of the installation scripts and the stability of the WebSocket connections across different environments.
78
114
115
+
If you wish to help polish this digital companion, please verify the code structure and report any inconsistencies.
79
116
117
+
##LicenseDistributed under the *GPLv3* license. See `LICENSE` for more information.
0 commit comments