POST /api/v1/resume/generate
Content-Type: application/json

{
  "userDescription": "I am a software engineer with 3 years of experience in Java and React. I have worked at tech startups and have experience with microservices and cloud technologies."
}
Response Example
json{
  "think": "Analyzing user background for software engineering role...",
  "data": {
    "personalInformation": {
      "fullName": "Generated Name",
      "email": "example@email.com",
      "phoneNumber": "+1234567890",
      "location": "City, Country",
      "linkedIn": "https://linkedin.com/in/profile",
      "gitHub": "https://github.com/username",
      "portfolio": null
    },
    "summary": "Experienced Software Engineer...",
    "skills": [
      {
        "title": "Java",
        "level": "Expert"
      }
    ],
    "experience": [...],
    "education": [...],
    "certifications": [...],
    "projects": [...],
    "achievements": [...],
    "languages": [...],
    "interests": [...]
  }
}
</details>
🎨 UI Components & Features
🔍 Key Frontend Components
ComponentDescriptionFeaturesLanding PageHero section with featuresResponsive design, testimonialsAI Input InterfaceNatural language inputLoading states, validationResume FormEditable structured formDynamic field arrays, form validationResume PreviewProfessional resume displayPDF export, print-ready
📱 Responsive Design

Mobile-First approach
Dark/Light theme support with DaisyUI
Accessible components with proper ARIA labels
Print-Optimized resume layouts

📁 Project Structure
ai-resume-maker/
├── 📂 resume-ai-backend/           # Spring Boot Backend
│   ├── 📂 src/main/java/com/resume/backend/
│   │   ├── 📄 ResumeAiBackendApplication.java
│   │   ├── 📄 ResumeRequest.java   # Request DTO
│   │   ├── 📂 controller/
│   │   │   └── 📄 ResumeController.java
│   │   └── 📂 service/
│   │       ├── 📄 ResumeService.java
│   │       └── 📄 ResumeServiceImpl.java
│   ├── 📂 src/main/resources/
│   │   ├── 📄 application.properties
│   │   └── 📄 resume_prompt.txt    # AI Prompt Template
│   └── 📄 pom.xml
│
├── 📂 resume_frontend/             # React Frontend
│   ├── 📂 src/
│   │   ├── 📂 api/
│   │   │   └── 📄 ResumeService.js # API Client
│   │   ├── 📂 components/
│   │   │   ├── 📄 Navbar.jsx
│   │   │   └── 📄 Resume.jsx       # Resume Display Component
│   │   ├── 📂 pages/
│   │   │   ├── 📄 GenerateResume.jsx
│   │   │   ├── 📄 LandingPage.jsx
│   │   │   └── 📄 Root.jsx
│   │   └── 📄 main.jsx
│   ├── 📄 package.json
│   ├── 📄 tailwind.config.js
│   └── 📄 vite.config.js
│
├── 📄 README.md
├── 📄 LICENSE
└── 📄 .gitignore
🧪 AI Model Configuration
🎯 Prompt Engineering
The application uses a sophisticated prompt template (resume_prompt.txt) that:

Structures Output - Ensures consistent JSON format
Covers All Sections - Personal info, skills, experience, projects, etc.
Maintains Professional Tone - Industry-appropriate language
Handles Edge Cases - Manages missing or incomplete information

🔧 Model Settings
properties# Current configuration
spring.ai.ollama.chat.model=deepseek-r1:latest

# Alternative models (uncomment to use)
# spring.ai.openai.api-key=your-openai-key
🧪 Testing
Backend Tests
bashcd resume-ai-backend
./mvnw test
Frontend Tests
bashcd resume_frontend
npm run test        # Run tests
npm run build       # Production build
npm run preview     # Preview production build
🚀 Deployment
<details>
<summary><b>🐳 Docker Deployment</b></summary>
```bash
# Create docker-compose.yml
version: '3.8'
services:
  backend:
    build: ./resume-ai-backend
    ports:
      - "8080:8080"
    environment:
      - SPRING_AI_OLLAMA_BASE_URL=http://ollama:11434
    depends_on:
      - ollama
frontend:
build: ./resume_frontend
ports:
- "3000:3000"
depends_on:
- backend
ollama:
image: ollama/ollama:latest
ports:
- "11434:11434"
volumes:
- ollama_data:/root/.ollama
volumes:
ollama_data:
Deploy
docker-compose up --build

</details>

<details>
<summary><b>☁️ Cloud Deployment</b></summary>

### Heroku Deployment
```bash
# Backend deployment
heroku create your-resume-ai-backend
git subtree push --prefix=resume-ai-backend heroku main

# Frontend deployment  
heroku create your-resume-ai-frontend
git subtree push --prefix=resume_frontend heroku main
Vercel/Netlify (Frontend)
bash# Build command: npm run build
# Output directory: dist
# Environment variable: VITE_API_URL=your-backend-url
</details>
🔧 Configuration
Environment Variables
Backend
properties# AI Configuration
spring.ai.ollama.chat.model=deepseek-r1:latest
spring.ai.ollama.base-url=http://localhost:11434

# Server Configuration
server.port=8080

# CORS Configuration (for production)
cors.allowed-origins=https://yourfrontend.com
Frontend
bash# API Configuration
VITE_API_URL=http://localhost:8080

# Build Configuration
VITE_NODE_ENV=development
🤝 Contributing
We love contributions! Here's how you can help:
<details>
<summary><b>🔧 Development Setup</b></summary>
```bash
# Fork the repository
git clone https://github.com/your-username/ai-resume-maker.git
cd ai-resume-maker
Create a feature branch
git checkout -b feature/amazing-feature
Make your changes
Test your changes
Commit with descriptive message
git commit -m "Add amazing feature"
Push to your fork
git push origin feature/amazing-feature
Create a Pull Request

</details>

### 🎯 Contribution Areas
- 🎨 **UI/UX Improvements** - Better designs and user experience
- 🤖 **AI Enhancements** - Better prompts and model integration
- 📱 **Mobile Optimization** - Enhanced mobile experience
- 🌍 **Internationalization** - Multi-language support
- 🧪 **Testing** - Unit tests and integration tests
- 📚 **Documentation** - Improved docs and tutorials

### 📝 Code Guidelines
- Follow **Java Spring Boot** best practices
- Use **React functional components** with hooks
- Maintain **consistent formatting** with Prettier/ESLint
- Write **clear commit messages**
- Add **tests** for new features

## 🐛 Troubleshooting

<details>
<summary><b>🔧 Common Issues & Solutions</b></summary>

### Ollama Connection Issues
```bash
# Check if Ollama is running
ollama list

# Restart Ollama service
ollama serve

# Pull model again if needed
ollama pull deepseek-r1:latest
Backend Issues
bash# Check Java version
java --version

# Clear Maven cache
./mvnw clean install

# Check application logs
./mvnw spring-boot:run --debug
Frontend Issues
bash# Clear node modules
rm -rf node_modules package-lock.json
npm install

# Check environment variables
echo $VITE_API_URL

# Build for production
npm run build
</details>
📊 Performance & Metrics
⚡ Performance Benchmarks

AI Response Time: ~3-5 seconds (local Ollama)
PDF Generation: ~1-2 seconds
Bundle Size: Frontend ~2MB gzipped
Memory Usage: Backend ~512MB, Frontend ~100MB

📈 Scalability

Concurrent Users: Supports 100+ simultaneous requests
AI Model: Can switch to cloud providers for scale
Database: Currently stateless (can add persistence)

📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🙏 Acknowledgments

Spring AI Team - For excellent AI integration framework
Ollama Community - For local LLM hosting
DeepSeek - For the powerful R1 model
DaisyUI - For beautiful, accessible components
React Community - For amazing frontend tools