Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nabil-nablotech committed Dec 29, 2023
1 parent 9b6e454 commit bbb7e94
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit bbb7e94

Please sign in to comment.