initial commit
This commit is contained in:
545
README.md
545
README.md
@@ -2,121 +2,33 @@
|
||||
|
||||
**AI-Powered Job Application Management System**
|
||||
|
||||
Transform your job search with intelligent document generation and strategic application management. JobForge leverages advanced AI to create tailored resumes and cover letters while streamlining your entire application workflow.
|
||||
Transform your job search with intelligent document generation and strategic application management. JobForge uses Claude Sonnet 4 and OpenAI to create tailored resumes and cover letters through a 3-phase AI workflow.
|
||||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://www.python.org/downloads/)
|
||||
[](https://fastapi.tiangolo.com/)
|
||||
[](https://www.postgresql.org/)
|
||||
[](https://www.docker.com/)
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Project Overview
|
||||
|
||||
### What is JobForge?
|
||||
|
||||
JobForge is an AI-powered job application management system designed to streamline and optimize the job search process. Built for individual job seekers, it combines strategic application management with advanced AI document generation to maximize your chances of landing interviews.
|
||||
|
||||
### Key Features (MVP)
|
||||
|
||||
✨ **3-Phase AI Workflow**
|
||||
- **Research Phase:** Automated job description analysis and company research
|
||||
- **Resume Optimization:** Multi-resume synthesis tailored to specific job requirements
|
||||
- **Cover Letter Generation:** Personalized cover letters with authentic voice preservation
|
||||
|
||||
🎨 **Modern Interface**
|
||||
- Professional web application built with Dash + Mantine components
|
||||
- Intuitive sidebar navigation and document management
|
||||
- Real-time processing status and progress tracking
|
||||
|
||||
🔒 **Secure & Private**
|
||||
- Complete user data isolation with PostgreSQL Row-Level Security
|
||||
- Local document storage with full user control
|
||||
- JWT-based authentication system
|
||||
|
||||
🤖 **AI-Powered Intelligence**
|
||||
- Claude Sonnet 4 for document generation and analysis
|
||||
- OpenAI embeddings for semantic document matching
|
||||
- Vector database for intelligent insights and recommendations
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Architecture Overview
|
||||
|
||||
### Technology Stack
|
||||
|
||||
| Component | Technology | Purpose |
|
||||
|-----------|------------|---------|
|
||||
| **Frontend** | Dash + Mantine | Modern, responsive web interface |
|
||||
| **Backend** | FastAPI + AsyncIO | High-performance REST API |
|
||||
| **Database** | PostgreSQL 16 + pgvector | Data persistence with vector search |
|
||||
| **AI Services** | Claude Sonnet 4, OpenAI | Document generation and analysis |
|
||||
| **Development** | Docker Compose | Containerized development environment |
|
||||
| **Authentication** | JWT + bcrypt | Secure user authentication |
|
||||
|
||||
### System Architecture
|
||||
|
||||
```mermaid
|
||||
graph TB
|
||||
subgraph "Frontend Layer"
|
||||
UI[Dash + Mantine UI]
|
||||
COMP[Reusable Components]
|
||||
end
|
||||
|
||||
subgraph "Backend API"
|
||||
API[FastAPI Rest API]
|
||||
AUTH[JWT Authentication]
|
||||
SERVICES[Business Services]
|
||||
end
|
||||
|
||||
subgraph "AI Processing"
|
||||
CLAUDE[Claude Sonnet 4]
|
||||
OPENAI[OpenAI Embeddings]
|
||||
AGENTS[AI Agents]
|
||||
end
|
||||
|
||||
subgraph "Data Layer"
|
||||
PG[(PostgreSQL + pgvector)]
|
||||
REDIS[(Redis Cache)]
|
||||
end
|
||||
|
||||
UI --> API
|
||||
API --> AUTH
|
||||
API --> SERVICES
|
||||
SERVICES --> AGENTS
|
||||
AGENTS --> CLAUDE
|
||||
AGENTS --> OPENAI
|
||||
SERVICES --> PG
|
||||
API --> REDIS
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
## 🚀 Quick Start (5 Minutes)
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- **Docker Desktop** 4.20+ with Docker Compose
|
||||
- **API Keys**: Claude API key, OpenAI API key
|
||||
- **Git** 2.30+
|
||||
- **API Keys:** Claude API key, OpenAI API key
|
||||
|
||||
### 1. Clone & Setup
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/your-org/jobforge-mvp.git
|
||||
cd jobforge-mvp
|
||||
|
||||
# Copy environment template
|
||||
# Copy environment template and add your API keys
|
||||
cp .env.example .env
|
||||
|
||||
# Add your API keys to .env file
|
||||
nano .env # Add CLAUDE_API_KEY and OPENAI_API_KEY
|
||||
```
|
||||
|
||||
### 2. Start Development Environment
|
||||
|
||||
```bash
|
||||
# Start all services (PostgreSQL, Backend, Frontend)
|
||||
docker-compose up -d
|
||||
@@ -125,258 +37,284 @@ docker-compose up -d
|
||||
docker-compose logs -f
|
||||
```
|
||||
|
||||
### 3. Access the Application
|
||||
### 3. Verify Installation
|
||||
Open these URLs to verify everything is working:
|
||||
- **Frontend Application**: http://localhost:8501
|
||||
- **Backend API**: http://localhost:8000
|
||||
- **API Documentation**: http://localhost:8000/docs
|
||||
|
||||
- **Frontend Application:** http://localhost:8501
|
||||
- **Backend API:** http://localhost:8000
|
||||
- **API Documentation:** http://localhost:8000/docs
|
||||
|
||||
### 4. Create Your First Application
|
||||
|
||||
1. Register a new account at http://localhost:8501
|
||||
2. Upload your resume(s) to the resume library
|
||||
3. Create a new job application with company details and job description
|
||||
4. Watch the AI generate your research report, optimized resume, and cover letter
|
||||
5. Edit and refine the generated documents as needed
|
||||
|
||||
---
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
### 📖 Core Documentation
|
||||
|
||||
| Document | Description | For |
|
||||
|----------|-------------|-----|
|
||||
| **[📋 MVP Architecture](docs/mvp-architecture.md)** | High-level system design and component overview | All team members |
|
||||
| **[🔧 Development Setup](docs/development-setup.md)** | Complete environment setup with troubleshooting | Developers |
|
||||
| **[🌿 Git Branch Strategy](docs/git-branch-strategy.md)** | Version control workflow and team coordination | All team members |
|
||||
|
||||
### 🛠️ Technical Documentation
|
||||
|
||||
| Document | Description | For |
|
||||
|----------|-------------|-----|
|
||||
| **[🔌 API Specification](docs/api-specification.md)** | Complete REST API documentation with examples | Backend developers |
|
||||
| **[🗄️ Database Design](docs/database-design.md)** | Schema, security policies, and optimization | Backend developers |
|
||||
| **[🧪 Testing Strategy](docs/testing-strategy.md)** | Testing guidelines and automation setup | All developers |
|
||||
|
||||
### 📝 Additional Resources
|
||||
|
||||
- **[📊 Project Roadmap](#roadmap)** - Development timeline and milestones
|
||||
- **[🤝 Contributing Guidelines](#contributing)** - How to contribute to the project
|
||||
- **[❓ FAQ](#faq)** - Common questions and answers
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Development Workflow
|
||||
|
||||
### Branch Strategy
|
||||
|
||||
We use a **Git Flow** approach with the following branches:
|
||||
|
||||
- **`main`** - Production-ready code (protected)
|
||||
- **`develop`** - Integration branch for completed features
|
||||
- **`feature/*`** - Individual feature development
|
||||
- **`hotfix/*`** - Emergency production fixes
|
||||
- **`release/*`** - Release preparation and testing
|
||||
|
||||
**Example feature branch names:**
|
||||
### 4. Quick Validation
|
||||
```bash
|
||||
feature/backend-user-authentication
|
||||
feature/frontend-application-sidebar
|
||||
feature/ai-claude-integration
|
||||
feature/database-rls-policies
|
||||
# Check backend health
|
||||
curl http://localhost:8000/health
|
||||
|
||||
# Check all services are running
|
||||
docker-compose ps
|
||||
```
|
||||
|
||||
See our **[Git Branch Strategy](docs/git-branch-strategy.md)** for detailed workflows.
|
||||
|
||||
### Development Process
|
||||
|
||||
1. **Start Feature:** Create branch from `develop`
|
||||
2. **Implement:** Follow coding standards and write tests
|
||||
3. **Test:** Ensure all tests pass and CI/CD checks succeed
|
||||
4. **Review:** Submit PR with detailed description
|
||||
5. **Merge:** Merge to `develop` after approval
|
||||
6. **Deploy:** Automatic deployment to staging environment
|
||||
All services should show "Up" status. If any issues, see [Troubleshooting](#-troubleshooting) below.
|
||||
|
||||
---
|
||||
|
||||
## 🏃♂️ Project Status
|
||||
## ✨ What is JobForge?
|
||||
|
||||
### Current Phase: MVP Development
|
||||
JobForge is an AI-powered job application management system that streamlines your job search through intelligent document generation. Built for individual job seekers, it combines strategic application management with advanced AI to maximize your chances of landing interviews.
|
||||
|
||||
**Timeline:** 8 weeks (July - August 2025)
|
||||
**Status:** 🚧 In Development
|
||||
**Target:** Production-ready MVP for personal use and concept validation
|
||||
### Key Features
|
||||
- **3-Phase AI Workflow**: Research → Resume Optimization → Cover Letter Generation
|
||||
- **Modern Interface**: Professional web app with intuitive navigation
|
||||
- **Secure & Private**: Complete user data isolation with PostgreSQL Row-Level Security
|
||||
- **AI-Powered**: Claude Sonnet 4 for document generation, OpenAI for semantic matching
|
||||
|
||||
### MVP Milestones
|
||||
|
||||
| Week | Milestone | Status |
|
||||
|------|-----------|--------|
|
||||
| **1-2** | Foundation & Infrastructure | 🚧 In Progress |
|
||||
| **3-4** | User Authentication & Application CRUD | ⏳ Planned |
|
||||
| **5-6** | AI Agents Integration | ⏳ Planned |
|
||||
| **7-8** | Frontend Polish & Release | ⏳ Planned |
|
||||
|
||||
### Feature Completion
|
||||
|
||||
- [x] Project setup and documentation
|
||||
- [x] Docker development environment
|
||||
- [ ] User authentication system
|
||||
- [ ] Application creation and management
|
||||
- [ ] AI-powered research generation
|
||||
- [ ] Resume optimization engine
|
||||
- [ ] Cover letter generation
|
||||
- [ ] Document editing interface
|
||||
- [ ] Production deployment
|
||||
### Technology Stack
|
||||
- **Frontend**: Dash + Mantine components
|
||||
- **Backend**: FastAPI + AsyncIO
|
||||
- **Database**: PostgreSQL 16 + pgvector
|
||||
- **AI**: Claude Sonnet 4, OpenAI embeddings
|
||||
- **Development**: Docker Compose
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Testing
|
||||
|
||||
### Testing Strategy
|
||||
|
||||
We maintain high code quality through comprehensive testing:
|
||||
|
||||
- **Unit Tests:** Business logic and services (80%+ coverage)
|
||||
- **Integration Tests:** API endpoints and database interactions
|
||||
- **Manual Testing:** Complete user workflows and edge cases
|
||||
- **AI Mocking:** Reliable testing without external API dependencies
|
||||
|
||||
### Running Tests
|
||||
## 🛠️ Development Commands
|
||||
|
||||
### Essential Commands
|
||||
```bash
|
||||
# Run all tests
|
||||
# Start all services
|
||||
docker-compose up -d
|
||||
|
||||
# View logs for all services
|
||||
docker-compose logs -f
|
||||
|
||||
# View logs for specific service
|
||||
docker-compose logs -f backend
|
||||
docker-compose logs -f frontend
|
||||
docker-compose logs -f postgres
|
||||
|
||||
# Stop all services
|
||||
docker-compose down
|
||||
|
||||
# Rebuild after code changes
|
||||
docker-compose up --build
|
||||
|
||||
# Reset database (WARNING: Deletes all data)
|
||||
docker-compose down -v && docker-compose up -d
|
||||
```
|
||||
|
||||
### Testing
|
||||
```bash
|
||||
# Run backend tests
|
||||
docker-compose exec backend pytest
|
||||
|
||||
# Run with coverage report
|
||||
# Run tests with coverage
|
||||
docker-compose exec backend pytest --cov=src --cov-report=html
|
||||
|
||||
# Run specific test file
|
||||
docker-compose exec backend pytest tests/unit/services/test_auth_service.py
|
||||
```
|
||||
|
||||
See **[Testing Strategy](docs/testing-strategy.md)** for detailed testing guidelines.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Deployment
|
||||
|
||||
### Development Environment
|
||||
|
||||
### Database Operations
|
||||
```bash
|
||||
# Start development environment
|
||||
docker-compose up -d
|
||||
# Connect to PostgreSQL database
|
||||
docker-compose exec postgres psql -U jobforge_user -d jobforge_mvp
|
||||
|
||||
# View service logs
|
||||
docker-compose logs -f [service_name]
|
||||
|
||||
# Stop environment
|
||||
docker-compose down
|
||||
# Check database health
|
||||
curl http://localhost:8000/health
|
||||
```
|
||||
|
||||
### Production Deployment
|
||||
---
|
||||
|
||||
Production deployment instructions will be added as we approach MVP completion. The current focus is on local development and testing.
|
||||
## 🏗️ Project Structure
|
||||
|
||||
```
|
||||
jobforge-mvp/
|
||||
├── src/
|
||||
│ ├── backend/ # FastAPI backend code
|
||||
│ │ ├── main.py # FastAPI app entry point
|
||||
│ │ ├── api/ # API route handlers
|
||||
│ │ ├── services/ # Business logic
|
||||
│ │ └── database/ # Database models and connection
|
||||
│ ├── frontend/ # Dash frontend code
|
||||
│ │ ├── main.py # Dash app entry point
|
||||
│ │ ├── components/ # UI components
|
||||
│ │ └── pages/ # Page components
|
||||
│ └── agents/ # AI processing agents
|
||||
├── database/
|
||||
│ └── init.sql # Database initialization
|
||||
├── docs/ # Detailed technical documentation
|
||||
├── docker-compose.yml # Development environment
|
||||
├── requirements-backend.txt
|
||||
├── requirements-frontend.txt
|
||||
└── .env.example # Environment template
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Contributing
|
||||
## 🔧 Environment Configuration
|
||||
|
||||
### Getting Started
|
||||
### Required Environment Variables
|
||||
Copy `.env.example` to `.env` and configure:
|
||||
|
||||
1. **Read the Documentation:** Start with [Development Setup](docs/development-setup.md)
|
||||
2. **Set Up Environment:** Follow the quick start guide above
|
||||
3. **Choose a Task:** Check open issues or discuss new features
|
||||
4. **Create Feature Branch:** Follow our [Git Branch Strategy](docs/git-branch-strategy.md)
|
||||
5. **Submit Pull Request:** Include tests and documentation updates
|
||||
```bash
|
||||
# API Keys (REQUIRED)
|
||||
CLAUDE_API_KEY=your_claude_api_key_here
|
||||
OPENAI_API_KEY=your_openai_api_key_here
|
||||
|
||||
### Development Standards
|
||||
# Database (Auto-configured for local development)
|
||||
DATABASE_URL=postgresql+asyncpg://jobforge_user:jobforge_password@postgres:5432/jobforge_mvp
|
||||
|
||||
- **Code Style:** Black formatter, isort imports, type hints required
|
||||
- **Testing:** Write tests for new functionality, maintain coverage
|
||||
- **Documentation:** Update relevant docs for user-facing changes
|
||||
- **Security:** Never commit API keys or sensitive data
|
||||
# JWT Secret (Generate random string)
|
||||
JWT_SECRET_KEY=your-super-secret-jwt-key-change-this-in-production
|
||||
|
||||
### Pull Request Process
|
||||
# Development Settings
|
||||
DEBUG=true
|
||||
LOG_LEVEL=INFO
|
||||
```
|
||||
|
||||
1. Create feature branch from `develop`
|
||||
2. Implement changes with tests
|
||||
3. Ensure all CI/CD checks pass
|
||||
4. Submit PR with detailed description
|
||||
5. Address code review feedback
|
||||
6. Merge after approval
|
||||
### Getting API Keys
|
||||
|
||||
#### Claude API Key
|
||||
1. Visit https://console.anthropic.com/
|
||||
2. Create account or log in
|
||||
3. Go to "API Keys" section
|
||||
4. Create new key with name "JobForge Development"
|
||||
5. Copy key to `.env` file
|
||||
|
||||
#### OpenAI API Key
|
||||
1. Visit https://platform.openai.com/api-keys
|
||||
2. Create account or log in
|
||||
3. Click "Create new secret key"
|
||||
4. Name it "JobForge Development"
|
||||
5. Copy key to `.env` file
|
||||
|
||||
---
|
||||
|
||||
## 📊 Roadmap {#roadmap}
|
||||
## 📚 Documentation
|
||||
|
||||
### Phase 1: MVP (Current - August 2025)
|
||||
All technical documentation is centralized in the `/docs` folder:
|
||||
|
||||
**Goal:** Production-ready job application management tool for personal use
|
||||
### Core Documentation
|
||||
- **[Development Setup](docs/development_setup.md)** - Complete environment setup with troubleshooting
|
||||
- **[MVP Architecture](docs/jobforge_mvp_architecture.md)** - High-level system design and component overview
|
||||
- **[API Specification](docs/api_specification.md)** - Complete REST API documentation with examples
|
||||
- **[Database Design](docs/database_design.md)** - Schema, security policies, and optimization
|
||||
|
||||
**Key Features:**
|
||||
- Complete 3-phase AI workflow
|
||||
- Professional web interface
|
||||
- Secure user authentication
|
||||
- Document management and editing
|
||||
|
||||
### Phase 2: SaaS Platform (September 2025+)
|
||||
|
||||
**Goal:** Multi-tenant SaaS platform with subscription billing
|
||||
|
||||
**Planned Features:**
|
||||
- Subscription management and billing
|
||||
- Usage analytics and insights
|
||||
- Advanced AI features and learning
|
||||
- Post-application tracking (interviews, responses)
|
||||
- Mobile application
|
||||
|
||||
### Phase 3: Advanced Features (Future)
|
||||
|
||||
**Goal:** Enterprise-grade job application platform
|
||||
|
||||
**Planned Features:**
|
||||
- Multi-language support
|
||||
- Integration with job boards and ATS systems
|
||||
- Advanced analytics and success prediction
|
||||
- White-label solutions for career coaches
|
||||
### Process Documentation
|
||||
- **[Git Branch Strategy](docs/git_branch_strategy.md)** - Version control workflow and team coordination
|
||||
- **[Testing Strategy](docs/testing_strategy.md)** - Testing guidelines and automation setup
|
||||
- **[Team Management](docs/team_management_guide.md)** - Team roles, processes, and standards
|
||||
|
||||
---
|
||||
|
||||
## ❓ FAQ {#faq}
|
||||
## 🐛 Troubleshooting
|
||||
|
||||
### General Questions
|
||||
### Common Issues
|
||||
|
||||
**Q: What makes JobForge different from other job application tools?**
|
||||
A: JobForge combines AI-powered document generation with strategic application management. Unlike simple trackers, it actively helps create better applications using advanced AI analysis and multi-resume optimization.
|
||||
#### "Port already in use"
|
||||
```bash
|
||||
# Check what's using the port
|
||||
lsof -i :8501 # or :8000, :5432
|
||||
|
||||
**Q: Is JobForge free to use?**
|
||||
A: The MVP is designed for personal use and concept validation. Future SaaS plans will include both free and paid tiers with different feature sets.
|
||||
# Kill the process or change ports in docker-compose.yml
|
||||
```
|
||||
|
||||
**Q: What AI models does JobForge use?**
|
||||
A: We use Claude Sonnet 4 for document generation and analysis, plus OpenAI embeddings for semantic search and document matching.
|
||||
#### "API Key Invalid"
|
||||
```bash
|
||||
# Verify API key format
|
||||
echo $CLAUDE_API_KEY # Should start with "sk-ant-api03-"
|
||||
echo $OPENAI_API_KEY # Should start with "sk-"
|
||||
|
||||
### Technical Questions
|
||||
# Ensure .env file is in project root
|
||||
ls -la .env
|
||||
```
|
||||
|
||||
**Q: Can I run JobForge without Docker?**
|
||||
A: While possible, Docker is strongly recommended for consistent development environments. Manual setup instructions may be added in the future.
|
||||
#### "Database Connection Failed"
|
||||
```bash
|
||||
# Check if PostgreSQL is running
|
||||
docker-compose ps postgres
|
||||
|
||||
**Q: How secure is my job application data?**
|
||||
A: Very secure. We use PostgreSQL Row-Level Security for complete user data isolation, JWT authentication, and all sensitive data is encrypted at rest.
|
||||
# Check database logs
|
||||
docker-compose logs postgres
|
||||
|
||||
**Q: Can I contribute to JobForge development?**
|
||||
A: Yes! Check our [Contributing Guidelines](#contributing) and [Development Setup](docs/development-setup.md) to get started.
|
||||
# Try connecting manually
|
||||
docker-compose exec postgres psql -U jobforge_user -d jobforge_mvp
|
||||
```
|
||||
|
||||
### Development Questions
|
||||
#### "Frontend Won't Load"
|
||||
```bash
|
||||
# Check frontend logs
|
||||
docker-compose logs frontend
|
||||
|
||||
**Q: What's the recommended development workflow?**
|
||||
A: Follow our [Git Branch Strategy](docs/git-branch-strategy.md) - create feature branches from `develop`, implement with tests, submit PRs for review.
|
||||
# Common issue: Backend not ready
|
||||
curl http://localhost:8000/health
|
||||
|
||||
**Q: How do I add a new API endpoint?**
|
||||
A: See our [API Specification](docs/api-specification.md) for examples and patterns, then follow the testing guidelines in [Testing Strategy](docs/testing-strategy.md).
|
||||
# Restart frontend
|
||||
docker-compose restart frontend
|
||||
```
|
||||
|
||||
**Q: Where can I find the database schema?**
|
||||
A: Complete schema documentation is in [Database Design](docs/database-design.md) including security policies and performance optimization.
|
||||
### Clean Restart
|
||||
If you encounter persistent issues:
|
||||
```bash
|
||||
# Complete clean restart
|
||||
docker-compose down -v
|
||||
docker system prune -f
|
||||
docker-compose up --build -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Development Workflow
|
||||
|
||||
### 1. Starting Development
|
||||
```bash
|
||||
# Ensure latest code
|
||||
git pull origin main
|
||||
|
||||
# Start environment
|
||||
docker-compose up -d
|
||||
|
||||
# Verify all services
|
||||
docker-compose ps
|
||||
curl http://localhost:8000/health
|
||||
```
|
||||
|
||||
### 2. Making Changes
|
||||
```bash
|
||||
# Backend changes auto-reload
|
||||
# Frontend changes auto-reload
|
||||
# Database changes require restart: docker-compose restart postgres
|
||||
```
|
||||
|
||||
### 3. Testing Changes
|
||||
```bash
|
||||
# Run tests
|
||||
docker-compose exec backend pytest
|
||||
|
||||
# Check logs
|
||||
docker-compose logs -f backend
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 MVP Development Status
|
||||
|
||||
### Current Phase: Foundation Setup ✅
|
||||
- [x] Project structure and documentation
|
||||
- [x] Docker development environment
|
||||
- [x] Database schema with RLS policies
|
||||
- [x] Environment configuration
|
||||
|
||||
### Next Phase: Core Implementation 🚧
|
||||
- [ ] User authentication system
|
||||
- [ ] Application CRUD operations
|
||||
- [ ] AI agents integration
|
||||
- [ ] Frontend UI components
|
||||
|
||||
### Future Phases 📋
|
||||
- [ ] AI-powered research generation
|
||||
- [ ] Resume optimization engine
|
||||
- [ ] Cover letter generation
|
||||
- [ ] Document editing interface
|
||||
- [ ] Production deployment
|
||||
|
||||
---
|
||||
|
||||
@@ -386,35 +324,14 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
||||
|
||||
---
|
||||
|
||||
## 🙏 Acknowledgments
|
||||
## 🤝 Contributing
|
||||
|
||||
- **Claude Sonnet 4** by Anthropic for advanced AI document generation
|
||||
- **OpenAI** for embedding models and semantic search capabilities
|
||||
- **FastAPI** community for the excellent async web framework
|
||||
- **Dash** and **Plotly** teams for the modern Python web framework
|
||||
- **PostgreSQL** and **pgvector** for robust data storage and vector search
|
||||
1. Fork the repository
|
||||
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
|
||||
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
|
||||
4. Push to the branch (`git push origin feature/amazing-feature`)
|
||||
5. Open a Pull Request
|
||||
|
||||
---
|
||||
|
||||
## 📞 Support & Contact
|
||||
|
||||
### Development Team
|
||||
|
||||
For development questions, bug reports, or feature requests:
|
||||
|
||||
- **Issues:** Use GitHub/Gitea issues for bug reports and feature requests
|
||||
- **Discussions:** Use GitHub/Gitea discussions for general questions
|
||||
- **Documentation:** Check the [docs](docs/) folder for detailed guides
|
||||
|
||||
### Getting Help
|
||||
|
||||
1. **Check Documentation:** Most questions are answered in our comprehensive docs
|
||||
2. **Search Issues:** Look for existing issues or discussions
|
||||
3. **Ask Questions:** Create new discussions for general questions
|
||||
4. **Report Bugs:** Use issue templates for bug reports
|
||||
|
||||
---
|
||||
|
||||
**Made with ❤️ for job seekers everywhere**
|
||||
|
||||
*Transform your job search. Forge your path to success.*
|
||||
**Ready to transform your job search? Let's build something amazing! 🚀**
|
||||
Reference in New Issue
Block a user