Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
CSantosM committed Jan 16, 2025
1 parent f5b9701 commit 6c7e3c3
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 6 deletions.
51 changes: 45 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@

OpenVidu Call is a versatile video conferencing application powered by **OpenVidu**, designed to support a wide range of use cases, from personal video calls to professional webinars. Built with **Angular**, OpenVidu Call offers two distinct modes of operation to cater to both non-technical users and developers seeking deep integration with their applications.

# Table of Contents

1. [Modes of Use](#modes-of-use)
1.1 [Full Mode](#full-mode)
1.2 [Embedded Mode (Call Embedded)](#embedded-mode-call-embedded)
2. [Feature Comparison: CE vs PRO](#feature-comparison-ce-vs-pro)
3. [Architecture Overview](#architecture-overview)
3.1 [Frontend](#frontend)
3.2 [Backend](#backend)
4. [Development](#development)
4.1 [Clone the Repository](#1-clone-the-openvidu-call-repository)
4.2 [Prepare the Project](#2-prepare-the-project)
4.3 [Start the Backend](#3-start-the-backend)
4.4 [Start the Frontend](#4-start-the-frontend)
5. [Build (with Docker)](#build-with-docker)
5.1 [Build the Backend Image](#build-the-backend-image)
5.2 [Run the Backend Container](#run-the-backend-container)

## Modes of Use

### Full Mode
Expand Down Expand Up @@ -68,22 +86,22 @@ 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.
- [**@types/openvidu-call**](https://github.com/OpenVidu/openvidu-call/tree/next/types): A library of common types used by the frontend and backend.
- [**typing**](./types/): Common types used by the frontend and backend.

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

## Development

For development purposes, you can run the application locally by following the instructions below.

Clone the OpenVidu Call repository:
**1. Clone the OpenVidu Call repository:**

```bash
git clone https://github.com/OpenVidu/openvidu-call.git --branch next
```

### Prepare the project
**2. Prepare the project**

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

Expand All @@ -92,7 +110,27 @@ cd openvidu-call
./prepare.sh
```

### Backend
> [!NOTE] > **The script prepare and build all necessary dependencies (shared-call-components and typings) for run te frontend and backend.**
>
> - For listening to changes to the **shared-call-components** library, you can run the following command:
>
> Stop the frontend server and run the following command:
>
> ```bash
> cd openvidu-call/frontend
> npm run lib:serve
> ```
>
> After that you can run the frontend server again.
>
> - For building the **typings**, you can run the following command:
>
> ```bash
> cd openvidu-call/types
> npm run sync-ce
> ```
**3. Start the Backend**
1. Serve the backend application.
Expand All @@ -101,7 +139,7 @@ cd backend && \
npm run dev:start
```
### Frontend
**4. Start the Frontend**

Opening a new tab, under root directory:

Expand All @@ -114,6 +152,7 @@ npm run dev:start

After running these commands, you can access the frontend application at [http://localhost:5080](http://localhost:5080).

### Advanced mode

## 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 6c7e3c3

Please sign in to comment.