From bbb7e947119c36d445452ea9fea3d56f7dfb5b98 Mon Sep 17 00:00:00 2001
From: Nabil Mohammed <nabil.nablotech@gmail.com>
Date: Fri, 29 Dec 2023 22:40:06 +0100
Subject: [PATCH] Updated readme

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/README.md b/README.md
index 8f50b16..3cc508c 100644
--- a/README.md
+++ b/README.md
@@ -30,3 +30,45 @@ Then you can run
 ```bash
 $ docker compose up -d
 ```
+
+# Frontend
+
+This is the frontend part of the camera security system. It is this part that enables
+user to interact with the system visually.
+
+## To Run the frontend locally
+
+### 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 frontend directory.
+
+If you are currently in root directory of this repo. Type the following in the terminal to change directory:
+```yaml
+cd ./Frontend/
+```
+
+### 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 Frontend directory.
+
+Copy the content of .env_example found in the Frontend root directory and change the variable values
+accordingly. 
+
+### 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 dev
+```
+Note: If you are running the backend locally make sure that you followed the steps in the [backend section](#backend).