README.md

# ClearPass AI - Java Swing Interview Simulator

ClearPass AI is a Java Swing-based desktop application that simulates AI-powered interview questions. It allows users to log in, specify a job role, answer AI-generated questions, receive real-time feedback, and view or export their session summaries.

## ✨ Features
- 🔐 User login and signup system (local file-based)
- 🧠 AI-generated interview questions based on job role (using Google's Gemini API)
- 😊 Sentiment analysis of answers (using HuggingFace's DistilBERT model)
- ✅ Real-time feedback on user responses
- ⏱ Countdown timer per question
- 📊 Progress tracker (answered vs. remaining)
- 💾 Save full session summary and result to `.txt` files
- 🧾 Clean MVC-based structure for easy updates

## 🛠 Requirements
- Java 8 or higher
- Internet connection (for AI API calls)
- JSON library (org.json)

## 📁 File Structure
```
project-root/
├── ClearPassAIApp.java
├── ClearPassAIGUI.java
├── InterviewScreen.java
├── LoginPage.java
├── WelcomeScreen.java
├── ResultScreen.java
├── DataModel.java
├── QuestionData.java
├── GeminiClient.java
├── HuggingFaceClient.java
├── users.txt
├── config.properties    <-- contains your API keys
```

## 🔑 Setup API Keys
1. Create a `config.properties` file in the root directory.
2. Add your API keys:

```properties
GEMINI_API_KEY=your_gemini_api_key_here
HUGGINGFACE_API_KEY=your_huggingface_api_key_here
```

## ▶️ How to Run
### If using terminal:
```bash
javac -cp ".:lib/json-20250107.jar" *.java
java -cp ".:lib/json-20250107.jar" ClearPassAIApp
```

### If using an IDE:
- Open the project.
- Add the JSON library to your project dependencies.
- Set `ClearPassAIApp` as the main class.
- Run the project.

## 💬 Sample Credentials
- Username: `dhruvparmar`
- Password: `1234`

You can create new users via the Sign-Up screen.

## 📂 Output Files
- `username_answers.txt` → contains each Q&A + feedback
- `username_summary.txt` → full interview session
- `username_result.txt` → saved from Result screen (if user clicks save)

## ✅ Future Improvements
- Add more AI models for different types of analysis
- Implement voice input/output
- Add support for different languages
- Enhance the UI with modern design elements

---
Made with 💙 by Dhruv Parmar