Skip to content

README.md

Latest commit

 

History

History
161 lines (104 loc) · 4.25 KB

README.md

File metadata and controls

161 lines (104 loc) · 4.25 KB

AI Assistant

Stars Forks Issues License

Welcome to AI Assistant, your personal AI companion! This intelligent assistant helps you brainstorm ideas, solve problems, and interact with AI in real-time. Built with Next.js, React, Clerk authentication, and Tailwind CSS, this app is fully responsive and optimized for all devices.

🌟 Features

  • Real-time Voice Chat with AI:

    • Start a live conversation with AI.

  • User Authentication with Clerk:

    • Secure Sign Up / Sign In.

  • Personalized User Experience:

    • Profile page showing user information.
    • AI remembers your session until the call ends.

  • Feedback System:

    • Users can submit feedback directly via email.
    • Email is sent instantly without storing data in a database.

  • Responsive Design:

    • Works perfectly on mobile, tablet, and desktop.
    • Smooth scrolling and animations for better UX.

  • Integration & API:

    • Uses Resend for email feedback.
    • AI powered by a custom Voice API (vapi) for interactive calls.

🛠 Tech Stack

  • Frontend and backend:
    React Next.js Tailwind CSS
  • Database:
    Convex
  • Authentication:
    Clerk
  • Email Feedback:
    Resend
  • Icons:
    Lucide
  • Hosting:
    Vercel

📱 Screenshots

Home / Dashboard

Home Screenshot

AI Assistant Call Interface

Call Start

Call Started

⬆ Back to Top

About

About

Profile Page

Profile Screenshot

Feedback Form

Feedback Screenshot

⬆ Back to Top

🚀 Getting Started

  1. Clone the repository:
git clone https://github.com/AmanRai8/ai_trainer.git
cd ai_trainer
  1. Clone the repository:
git clone https://github.com/AmanRai8/ai_trainer.git
cd ai_trainer
  1. Install Dependencies:
npm install
  1. Configure Environment Variables:
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_public_clerk_publishable_key
CLERK_SECRET_KEY=your_clerk_secret_key

NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up

NEXT_PUBLIC_VAPI_WORKFLOW_ID=your_vapi_assistant_id
NEXT_PUBLIC_VAPI_API_KEY=your_vapi_api_key


CONVEX_DEPLOYMENT=your_convex_deployment

NEXT_PUBLIC_CONVEX_URL=your_public_convex_url

RESEND_API_KEY=your_resend_api_key
  1. Run the app:
npm run dev

⬆ Back to Top

🤝 Contributing

Contributions are welcome!

  1. Fork the repo
  2. Create a new branch (git checkout -b feature-branch)
  3. Commit changes (git commit -m "Added new feature")
  4. Push (git push origin feature-branch)
  5. Open a Pull Request

⬆ Back to Top