Quick Start Guide

This guide will help you set up your local development environment for the CallVideo platform. We recommend using yarn as the package manager for all CallVideo projects.

Prerequisites

Before you begin, make sure you have the following installed:

Node.js
Yarn
Git
A code editor (we recommend Visual Studio Code)

Clone the API Repository

git clone https://github.com/callvideo/callvideo-api

Install Dependencies
```
cd callvideo-api
yarn install
```
Configure Environment Variables
```
cp .env.example .env
```
You’ll need to obtain the actual environment variable values from the development team to populate the .env file. The example files contain placeholders that won’t work for actual development.
Start the Development Server
```
yarn run start:dev
```

Clone the Socket Server Repository

git clone https://github.com/callvideo/callvideo-socket-server

Install Dependencies

cd callvideo-socket-server
yarn install

Configure Environment Variables
```
cp .env.example .env
```
You’ll need to obtain the actual environment variable values from the development team to populate the .env file. The example files contain placeholders that won’t work for actual development.
Start the Development Server
```
yarn run start:dev
```

Frontend Setup

Clone the Repository

git clone https://github.com/pessoalize/callvideo-admin-web-app

Install Dependencies

cd callvideo-admin-web-app
yarn install

Configure Environment Variables
```
cp .env.example .env
```
You’ll need to obtain the actual environment variable values from the development team. The example files contain placeholders that won’t work for actual development.
Start the Development Server
```
yarn run dev
```

Clone the Repository

git clone https://github.com/pessoalize/callvideo-attendant-web-app

Install Dependencies

cd callvideo-attendant-web-app
yarn install

Configure Environment Variables
```
cp .env.example .env
```
You’ll need to obtain the actual environment variable values from the development team. The example files contain placeholders that won’t work for actual development.
Start the Development Server
```
yarn run dev
```

Clone the Repository

git clone https://github.com/pessoalize/callvideo-customer-web-app

Install Dependencies

cd callvideo-customer-web-app
yarn install

Configure Environment Variables
```
cp .env.example .env
```
You’ll need to obtain the actual environment variable values from the development team. The example files contain placeholders that won’t work for actual development.
Start the Development Server
```
yarn run dev
```

Clone the Repository

git clone https://github.com/pessoalize/callvideo-superadmin-web-app

Install Dependencies

cd callvideo-superadmin-web-app
yarn install

Configure Environment Variables
```
cp .env.example .env
```
You’ll need to obtain the actual environment variable values from the development team. The example files contain placeholders that won’t work for actual development.
Start the Development Server
```
yarn run dev
```

External Services

The CallVideo platform relies on several external services that you don’t need to run locally but will be connected to:

MongoDB: Database for storing application data
S3 Storage: For storing call recordings and files
Twilio: For video call functionality
Unipix: For SMS notifications

These services are accessed through their APIs using credentials provided in the .env files.

Testing Your Setup

To verify that your setup is working correctly, follow the How to Start a Call guide to test the complete flow between the customer and attendant applications.

Troubleshooting

If you encounter issues during setup:

Ensure all backend services are running
Check that your .env files contain the correct values
Check the console logs for specific error messages

For persistent issues, contact the development team for assistance.