Streaming Avatar 🌟

Welcome to the Streaming Avatar repository! This full-stack application enables real-time avatar streaming using HeyGen and Gemini AI. Built during a hackathon by Team "Bit by Bit," this project showcases the power of modern web technologies.

Table of Contents

• Features
• Technologies Used
• Getting Started
• Usage
• Contributing
• License
• Contact

Features

• Real-time Avatar Streaming: Users can create and stream avatars in real-time.
• User-Friendly Interface: Built with React and Tailwind CSS for a smooth user experience.
• TypeScript Support: Strong typing for better code quality and maintainability.
• API Integration: Seamless integration with HeyGen and Gemini AI APIs.
• Responsive Design: Works on all devices, from desktops to mobile.

Technologies Used

This project utilizes a variety of technologies to deliver a robust application:

• Frontend:

  • React
  • TypeScript
  • Tailwind CSS

• Backend:

  • Node.js
  • Express

• APIs:

  • HeyGen API
  • Gemini API

Getting Started

To get started with the Streaming Avatar application, follow these steps:

1. Clone the Repository:

   git clone https://github.com/LiehSt/Streaming-Avatar.git
   cd Streaming-Avatar

2. Install Dependencies: For the frontend:

   cd client
   npm install

   For the backend:

   cd server
   npm install

3. Set Up Environment Variables: Create a .env file in the server directory and add your API keys for HeyGen and Gemini.

4. Run the Application: Start the backend server:

   cd server
   npm start

   Then, in a new terminal, start the frontend:

   cd client
   npm start

5. Access the Application: Open your browser and go to http://localhost:3000 to view the application.

Usage

Once the application is running, you can start creating avatars. Follow these steps:

1. Create an Avatar: Use the provided form to customize your avatar.
2. Stream Your Avatar: Click on the stream button to start broadcasting.
3. Interact: Engage with other users in real-time.

Contributing

We welcome contributions! To contribute to the Streaming Avatar project:

1. Fork the Repository: Click on the "Fork" button at the top right corner of this page.
2. Create a Branch:

   git checkout -b feature/YourFeature

3. Make Your Changes: Implement your feature or fix a bug.
4. Commit Your Changes:

   git commit -m "Add Your Feature"

5. Push to Your Branch:

   git push origin feature/YourFeature

6. Create a Pull Request: Go to the original repository and click on "New Pull Request."

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or feedback, feel free to reach out:

• Team Bit by Bit: Contact Us

Additional Resources

For more information on the technologies used, check out the following links:

• React Documentation
• TypeScript Documentation
• Tailwind CSS Documentation
• Node.js Documentation
• Express Documentation

Releases

You can find the latest releases of the Streaming Avatar application here. Download the latest version and execute it to experience the app.

Conclusion

Thank you for checking out the Streaming Avatar project. We hope you find it useful and enjoyable. Feel free to contribute and help us improve the application. Happy streaming!