Getting Started

In this section, we will build the Nyra Agent playground together.

Perquisites

Api Keys

• Agora App ID and App Certificate (free minutes every month)

Installations

• Docker / Docker Compose

• Node.js(LTS) v18

Minimum System requirements

💻 CPU >= 2 Core 💿 RAM >= 4 GB

Docker settings on Apple Silicon

For Apple Silicon Macs, uncheck "Use Rosetta for x86/amd64 emulation" in Docker settings. Note: This may result in slower build times on ARM, but performance will be normal when deployed to x64 servers.

Make sure the box is unchecked

Next Step

1. Clone down the NYRA Agent repository

>_terminal

git clone https://github.com/NYRA-framework/NYRA-Agent.git

2. Prepare config files

Open NYRA Agent in your code editor. In the root of the project, use cd command to create `.env` file from example.

>_terminal

cp ./.env.example ./.env

3. Setup Agora App ID and App Certificate in .env file

Open the .env file and input the Agora App ID and App Certificate. These will be used to connect to Agora RTC extension.

.env

AGORA_APP_ID=
AGORA_APP_CERTIFICATE=

4. Start agent builder toolkit containers

In the same directory, run the docker command to create the containers:

>_terminal

docker compose up -d

5. Enter container

Use this command to enter into the container:

>_Bash

docker exec -it nyra_agent_dev bash

6. Build the agent Use this command to build your agent:

>_Bash

task use

7. Start your web server

Use the following command to start the web server:

>_Bash

task run

8. Edit the playground settings

1. Select your graph type (e.g. Voice Agent, Realtime Agent)

2. Choose the corresponding module

3. Select an extension and configure the API key settings

Open the playground at localhost:3000 to configure your agent.