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
Copy file name to clipboardExpand all lines: README.md
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -85,9 +85,13 @@ REACT_APP_WS_PROTOCOL=wss
85
85
86
86
*Note: Ensure your SSL certificates are generated and placed correctly to allow the browser to trust the local camera stream.*
87
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).
88
+
##Usage
89
89
90
-
###Awakening the System1. **Start the Database:** Ensure your MongoDB instance is running locally.
90
+
Once the environment is prepared, the system must be awakened manually. The architecture requires the simultaneous operation of the brain (backend) and the eyes (frontend).
91
+
92
+
### Awakening the System
93
+
94
+
1.**Start the Database:** Ensure your MongoDB instance is running locally.
91
95
2.**Start the Brain:** In your terminal, navigate to the backend directory and launch the secure server:
92
96
```bash
93
97
python main.py https
@@ -101,11 +105,15 @@ npm start
101
105
102
106
103
107
104
-
###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).
108
+
### The Experience
109
+
110
+
Upon 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
111
106
112
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
113
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.
114
+
## Contributing
115
+
116
+
We 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
117
110
118
Our primary need is for **Testers** and **Code Reviewers**.
111
119
@@ -114,4 +122,6 @@ Our primary need is for **Testers** and **Code Reviewers**.
114
122
115
123
If you wish to help polish this digital companion, please verify the code structure and report any inconsistencies.
116
124
117
-
##LicenseDistributed under the *GPLv3* license. See `LICENSE` for more information.
125
+
## License
126
+
127
+
Distributed under the *GPLv3* license. See `LICENSE` for more information.
0 commit comments