README.md

Lyrebird Voice Tournament Sample App

This project aims to provide a sample use case of the Lyrebird Custom Avatar API. You can have a look at the deployed version at: Example App. This sample was implemented using Lyrebird Vocal Avatar API.

Getting Started

Prerequisites

You’ll need to install:

• Node Js - Download | Node.js
• Docker - Docker Documentation | Docker Documentation
• Docker-compose - Install Docker Compose | Docker Documentation

Installing

Creating a Lyrebird application

Go to Lyrebird My Voice Application and create an application. Please note the CLIENT_ID and CLIENT_SECRET provided to you. In the .env file in the root folder ion this application, edit the variable LYREBIRD_CLIENT_ID and LYREBIRD_CLIENT_SECRET with the ones just given to you.

Starting the sample application

To Start the sample application, you can either use docker-compose (faster) or start it manually.

Using Docker

• cd lyrebird-tournament-app/
• docker-compose up
• Navigate to http://localhost:4040

Manually

• Install mongo-db Install MongoDB — MongoDB Manual
• Edit the DB_URL in .env file to point it to your local MongoDb instance
• cd lyrebird-tournament-app/
• npm install
• npm start
• Navigate to http://localhost:4040

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Terms

Your use of this sample is subject to, and by using or downloading the sample files you agree to comply with, the Lyrebird APIs Terms of Service.

Slack Group

If you have some questions, please visit our slack group: https://avatar-api-support.slack.com/.