Skip to content

firewindy930/retell-voice-assistant

Repository files navigation

Retell Voice Bot

A React-based voice assistant application built with Retell AI, featuring an interactive voice interface with modern UI components.

Features

  • πŸŽ™οΈ Real-time voice conversations with AI
  • 🎨 Beautiful, modern UI with Tailwind CSS
  • ⚑ Built with Vite for fast development
  • πŸ”„ Framer Motion animations
  • πŸ“± Responsive design

Prerequisites

  • Node.js (v18 or higher recommended)
  • npm or yarn
  • Retell AI API credentials

Installation

  1. Clone the repository:
git clone <repository-url>
cd retell_voice_bot
  1. Install dependencies:
npm install
  1. Set up environment variables:
cp .env.example .env
  1. Edit the .env file with your Retell AI credentials:
VITE_RETELL_API_KEY=Bearer your_api_key_here
VITE_RETELL_AGENT_ID=your_agent_id_here
VITE_RETELL_LLM_ID=your_llm_id_here

Getting Your Retell AI Credentials

  1. Sign up for a Retell AI account at retell.ai
  2. Create an agent in your Retell AI dashboard
  3. Generate an API key
  4. Copy your Agent ID, LLM ID, and API Key
  5. Paste them into your .env file

Running the Application

Development Mode

Start the development server:

npm run dev

The application will be available at http://localhost:5173

Production Build

Build for production:

npm run build

Preview the production build:

npm preview

Project Structure

retell_voice_bot/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ App.tsx           # Main application component
β”‚   β”œβ”€β”€ main.tsx          # Application entry point
β”‚   β”œβ”€β”€ lib/
β”‚   β”‚   β”œβ”€β”€ retell.ts     # Retell SDK integration
β”‚   β”‚   └── utils.ts      # Utility functions
β”‚   └── components/
β”‚       └── ui/
β”‚           └── lamp.tsx  # Lamp UI component
β”œβ”€β”€ .env                  # Environment variables (not committed)
β”œβ”€β”€ .env.example          # Environment variables template
└── package.json          # Dependencies and scripts

Environment Variables

All sensitive credentials are stored in environment variables to protect your API keys. Never commit .env to version control.

Required environment variables:

  • VITE_RETELL_API_KEY: Your Retell AI API key with Bearer prefix
  • VITE_RETELL_AGENT_ID: Your Retell agent ID
  • VITE_RETELL_LLM_ID: Your LLM configuration ID

Security Notes

βœ… Security Best Practices Implemented:

  • All API keys are stored in .env files
  • .env files are excluded from git via .gitignore
  • No hardcoded credentials in source code
  • Environment variables prefixed with VITE_ for client-side exposure

Technologies Used

  • React - UI framework
  • TypeScript/JavaScript - Programming languages
  • Vite - Build tool and dev server
  • Tailwind CSS - Styling
  • Framer Motion - Animations
  • Retell AI SDK - Voice AI integration
  • Lucide React - Icons

Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run preview - Preview production build
  • npm run lint - Run ESLint

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

License

MIT License - see LICENSE file for details

GitHub Repository Setup

Repository Name

retell-voice-assistant

Repository Description

πŸŽ™οΈ Modern voice assistant built with React and Retell AI. Features real-time voice conversations, beautiful UI with Tailwind CSS, and smooth animations with Framer Motion. Perfect for building conversational AI interfaces with clean, production-ready code.

Topics/Tags

voice-assistant, react, retell-ai, conversational-ai, voice-interface, tailwindcss, framer-motion, vite, typescript, react-typescript, ai-integration, web-voice-app, modern-ui, real-time-communication, voice-bot, ai-chat, interactive-ui, production-ready

Support

For issues related to:

  • This application: Open an issue on GitHub
  • Retell AI: Visit retell.ai for documentation and support

About

πŸŽ™οΈ Modern voice assistant built with React and Retell AI. Features real-time voice conversations, beautiful UI with Tailwind CSS, and smooth animations with Framer Motion. Perfect for building conversational AI interfaces with clean, production-ready code.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors