Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CSantosM committed Jan 10, 2025
1 parent d70632d commit fd688ea
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 18 deletions.
51 changes: 33 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,10 @@ The OpenVidu Call application is composed of two main parts (frontend and backen
Also, the frontend project installs external dependencies on the following libraries:

- [**openvidu-components-angular**](https://github.com/OpenVidu/openvidu/tree/master/openvidu-components-angular): A library of Angular components that provide the core functionality of the video conferencing service.
- [**common-types**](https://github.com/OpenVidu/openvidu-call/tree/next/common-types): A library of common types used by the frontend and backend.
- [**@types/openvidu-call**](https://github.com/OpenVidu/openvidu-call/tree/next/types): A library of common types used by the frontend and backend.

- **Backend**: The backend is a Node.js application.
- [**common-types**](https://github.com/OpenVidu/openvidu-call/tree/next/common-types): A library of common types used by the frontend and backend.
- [**@types/openvidu-call**](https://github.com/OpenVidu/openvidu-call/tree/next/types): A library of common types used by the frontend and backend.

## Development

Expand All @@ -83,46 +83,61 @@ Clone the OpenVidu Call repository:
git clone https://github.com/OpenVidu/openvidu-call.git --branch next
```

### Prepare the project

For building types and install dependencies, run the following command:

```bash
cd openvidu-call
./prepare.sh
```

### Backend

1. Serve the backend application.

```bash
cd openvidu-call/backend && \
npm install && npm run dev:start
cd backend && \
npm run dev:start
```

### Frontend

1. Build the **common-types** library.
Opening a new tab, under root directory:

1. Serve the frontend application.

```bash
cd openvidu-call/common-types && \
npm install && npm run sync-ce
cd frontend && \
npm run dev:start
```

> NOTE: If you plan to make changes to the **common-types** library, the best idea is serve it locally. To do this, follow the instructions below:
After running these commands, you can access the frontend application at [http://localhost:5080](http://localhost:5080).

```bash
npm run serve
```
> [!NOTE]
> As the frontend project uses **shared-call-components** and **@types/openvidu-call** libraries, you could need make changes to these libraries when developing and have the changes reflected in the frontend application. To do this, follow the instructions below:
- Stop the backend and frontend processes.

2. Serve the **shared-call-components** library.
- Serve the **common-types** library.

```bash
cd ../frontend && \
npm install && npm run lib:serve
cd types && \
npm run serve
```

3. Serve the frontend application.
> This command will make your terminal busy, so you need to open a new terminal to continue with the next steps.
**Opening another terminal**:
- Serve the **shared-call-components** library.

```bash
npm run dev:start
cd frontend && \
npm run lib:serve
```

After running these commands, you can access the frontend application at [http://localhost:5080](http://localhost:5080).
> This command will make your terminal busy, so you need to open a new terminal to continue with the next steps.
- Serve the backend and frontend applications again.


## Build (with docker)
Expand Down
Binary file modified docs/openvidu-call-ce-architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fd688ea

Please sign in to comment.