docs: update README to include testing application pre-requisites and clarify types synchronization

This commit is contained in:
Carlos Santos 2025-06-10 18:45:44 +02:00
parent 777b2da6cd
commit e3cce4a03c

View File

@ -53,7 +53,6 @@ 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
@ -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