From e3cce4a03c9dbc6394b9c31cb74ea2cf4c090536 Mon Sep 17 00:00:00 2001 From: Carlos Santos <4a.santos@gmail.com> Date: Tue, 10 Jun 2025 18:45:44 +0200 Subject: [PATCH] docs: update README to include testing application pre-requisites and clarify types synchronization --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fa3a515..9495946 100644 --- a/README.md +++ b/README.md @@ -53,14 +53,13 @@ cd openvidu-meet > [!NOTE] > For development purposes, the backend application uses the `backend/.env.development` file to load environment variables. You can customize the values in this file to suit your local development environment. - ```bash cd backend && \ npm run start:dev ``` > [!NOTE] -> **The types under `typings` are shared between the frontend and backend projects.** +> **The types under `typings` are shared between the frontend and backend projects.** > If you need to update the comon types, remember doing it in the `typings` project. > > Every time you make changes to the types, the backend process will automatically invoke the syncing task to update the types in the frontend and backend projects. So, you don't need to worry about updating the types manually. @@ -78,11 +77,21 @@ This command will build the frontend application and move the files to the backe After running these commands, you can access the frontend application at [http://localhost:6080](http://localhost:6080). - ## Testing This repository offers a testing application that allows you to test the OpenVidu Meet. +### Pre-requisites + +To run the testing application, you need to have the following pre-requisites installed: + +- [Node.js](https://nodejs.org/en/download/) (version 22 or higher) +- LiveKit CLI installed and configured. + +```bash +curl -sSL https://get.livekit.io/cli | bash +``` + To run the testing application, follow these steps under the root directory: 1. Install the dependencies: @@ -100,7 +109,6 @@ npm run start After running these commands, you can access the testing application at [http://localhost:5080](http://localhost:5080). - ## Build (with docker) ### Build the backend image