From 9de1f6c19ec2234f42ddfb986ab568484a409b19 Mon Sep 17 00:00:00 2001
From: Glydric <git@miglio.dev>
Date: Fri, 19 Jan 2024 19:22:46 +0100
Subject: [PATCH] recovered readme

---
 README.md | 99 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 93 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index ca0ab4f..789b7c8 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,58 @@
 # camera-security-system-monorepo
-The repository contains the sources code for the Camera Security System project.
+The repository contains the sources code for the Camera Security System project(CSS).
+
+# Architecture
+The CSS is mainly composed of three 5 components:
+    1. Frontend: It is the UI that enables the user to view and use the project in the browser.
+    2. Backend: It is responsible for authentication, logging detection events, and establish       communication between the frontend and the media server to access the IP Cameras.  
+    3. Media Server: It is responsible for delivering the camera streams from the IP Cameras to the frontend. We have used [OpenVidu](openvidu.io/) for implementing the media server.
+    4. Machine learning: It is responsible for analyzing the camera streams and check if an object is 
+    detected.
+    5. IPCameras: These are the cameras that captures videos of the surrounding.
+
+In order to successfully run the full project components in your local machine, launch the components in the following order:
+    1. Install your IP Cameras in the areas desired and connect it to the network.
+    2. Run the media server.  
+    3. Run the backend.
+    4. Run the frontend.
+    5. Run the machine learning component.
+
+Below, you will get full details on how to run each component.
+
+# Media Server
+
+### 0- Prerequisite
+You should first install docker in your machine.
+You can get more information [here](https://docs.docker.com/engine/)
+### 1- Open terminal
+
+First open the terminal and move to the backend directory.
+
+If you are currently in root directory of this repo. Type the following in the terminal to change directory:
+```yaml
+cd ./Backend/
+```
+
+### 2- Define environment variables(Configuration)
+In order to run the application you will need to define the environment variable by creating
+by specifying environment variable file in the root Backend directory.
+
+You can use the .env-openvidu file found in the Backend root directory. You can modify some variables according to your need.  
+
+### 3- Run the component
+
+Install the required packages by running:
+```yaml
+docker run -p 4443:4443 --rm --env-file .env-openvidu  openvidu/openvidu-dev:2.29.0
+```
+
 
 # Backend
 
 ## Just Run
 
+If you prefer running the backend using docker do the following:
+
 Firstly add .secrets.yml file to root directory using the following template
 ```yaml
 # mongodb+srv is the protocol when connecting to cloud mongodb
@@ -25,16 +73,55 @@ CSD_PASSWORD=Password
 TELEGRAM_TOKEN=api_token
 # Should be of the format of BCrypt hash
 BCRYPT_SALT=...
-# folder path. It is relative to the backend location. The folder directory should never be absolute or start with / 
-HLS_OUTPUT_DIRECTORY=HLS_OUTPUT
-# Master file name of HLS stream
-HLS_FILE_NAME=index.m3u8
+# Put the openvidu URL of the component that you have launched earlier
+OPENVIDU_URL= http://localhost:4443/
+# Put the OPENVIDU_SECRET of the component that you have launched earlier
+OPENVIDU_SECRET=MY_SECRET 
 ```
 Then you can run
 ```bash
 $ docker compose up -d
 ```
 
+If you prefer running the backend directly using the terminal do the following:
+
+### 0- Prerequisite
+
+You should first install node.js in your machine.
+You can get more information [here](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs)
+
+### 1- Open terminal
+
+First open the terminal and move to the backend directory.
+
+If you are currently in root directory of this repo. Type the following in the terminal to change directory:
+```yaml
+cd ./Backend/
+```
+
+### 2- Define environment variables
+In order to run the application you will need to define the environment variable by creating
+.env file in the root Backend directory.
+
+Copy the content of .env_example found in the Backend root directory and change the variable values
+accordingly. You can also run the backend by just adding the telegram token and leave the rest of the config as it is.
+
+### 3- Install packages
+
+Install the required packages by running:
+```yaml
+npm install
+```
+
+### 4- Run the application
+
+Run the application using this command:
+
+```yaml
+npm run start
+```
+Note: If you are running the backend locally make sure that you followed the steps in the [Media Server Section](#media-server). 
+
 # Frontend
 
 This is the frontend part of the camera security system. It is this part that enables
@@ -48,7 +135,7 @@ You can get more information [here](https://nodejs.org/en/learn/getting-started/
 First open the terminal and move to the frontend directory.
 
 If you are currently in root directory of this repo. Type the following in the terminal to change directory:
-```bash
+```yaml
 cd ./Frontend/
 ```