Skip to content

INSTALL.md

Latest commit

 

History

History
103 lines (72 loc) · 2.02 KB

INSTALL.md

File metadata and controls

103 lines (72 loc) · 2.02 KB

🚀 Installation Guide

Quick Start (5 minutes)

1. Prerequisites

2. Install the Application

# Clone or download the project
cd interview-assistant

# Install all dependencies
npm install

# Set up environment
cp env.example .env

3. Configure OpenAI API

Edit the .env file and add your API key:

OPENAI_API_KEY=your-api-key-here

4. Run the Application

# Start everything (backend + desktop app)
npm run dev

Alternative: Manual Setup

If you prefer to run components separately:

# Terminal 1: Start backend server
npm run server

# Terminal 2: Start desktop app
npm run electron-dev

🎯 First Use

  1. Set up your profile: Click "Resume Manager" and fill in your details
  2. Test recording: Click the microphone button and say "Tell me about yourself"
  3. Generate answer: Click "Generate Perfect Answer" to see AI response
  4. Listen: Click "Speak Answer" to hear it aloud

🔧 Troubleshooting

Common Issues

"Cannot find module" errors:

npm install

Microphone not working:

  • Check system permissions
  • Close other apps using microphone
  • Try refreshing the app

OpenAI API errors:

  • Verify your API key is correct
  • Check you have credits in your OpenAI account
  • Ensure you have access to GPT-4o and Whisper APIs

Port already in use:

# Kill process on port 5000
npx kill-port 5000
npm run dev

Getting Help

  • Check the console for error messages
  • Ensure all environment variables are set
  • Verify internet connection for API calls

📦 Building for Distribution

# Build the application
npm run build

# Package for your platform
npm run electron-pack

Built files will be in the dist/ folder.

🎉 You're Ready!

The app should now be running. Start by setting up your resume data and testing the voice recording feature.

Happy interviewing! 🎯