roastume
RoastUme - CV Roasting Service π₯
A fun and friendly CV review service that provides constructive feedback with a humorous twist. Get your resume reviewed by our witty AI critic who'll help you improve while keeping things light and entertaining.
#Author
Created by: [Your Name]
Contact: [Your Email]
GitHub: [Your GitHub Profile]
Contact: [Your Email]
GitHub: [Your GitHub Profile]
#Features
- π Upload CV in PDF format
- π€ AI-powered review using DeepSeek
- π Friendly and casual roasting style
- π Structured feedback with scores
- π¨ Modern, responsive UI with Tailwind CSS
- π Fast processing and real-time updates
#Tech Stack
##Backend
- Python 3.9+ - Core backend logic
- FastAPI - Modern web framework
- DeepSeek API - AI review generation
- PyPDF2 - PDF text extraction
- Pydantic - Data validation
##Frontend
- TypeScript - Type-safe JavaScript
- React - UI framework
- Tailwind CSS - Utility-first styling
- Vite - Build tool and dev server
#Architecture
roastume/
βββ backend/ # Python FastAPI backend
β βββ app/
β β βββ core/ # Core business logic
β β βββ services/ # External services (DeepSeek)
β β βββ models/ # Data models
β β βββ api/ # API routes
β β βββ utils/ # Utility functions
β βββ config/ # Configuration
β βββ requirements.txt
βββ frontend/ # TypeScript React frontend
β βββ src/
β β βββ components/ # Reusable components
β β βββ pages/ # Page components
β β βββ services/ # API services
β β βββ types/ # TypeScript types
β β βββ constants/ # App constants & strings
β β βββ utils/ # Utility functions
β βββ package.json
β βββ tailwind.config.js
βββ README.md
#Installation & Setup
##Prerequisites
- Python 3.9 or higher
- Node.js 16 or higher
- DeepSeek API key
##Local Development
-
Clone the repository
git clone <repository-url> cd roastume
-
Backend Setup
cd backend python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate pip install -r requirements.txt
-
Environment Configuration
cp .env.example .env # Edit .env with your DeepSeek API key
-
Frontend Setup
cd ../frontend npm install
-
Run Development ServersTerminal 1 (Backend):
cd backend source venv/bin/activate uvicorn app.main:app --reload --port 8000
Terminal 2 (Frontend):cd frontend npm run dev
-
Access the Application
- Frontend: http://localhost:5173
- Backend API: http://localhost:8000
- API Documentation: http://localhost:8000/docs
##Production Deployment
###Docker Deployment
docker-compose up --build
###Manual Deployment
Backend (FastAPI):
- Deploy to services like Heroku, Railway, or AWS
- Set environment variables
- Use gunicorn for production WSGI server
Frontend (React):
- Build:
npm run build
- Deploy to Vercel, Netlify, or serve static files
###Environment Variables
DEEPSEEK_API_KEY=your_deepseek_api_key_here
CORS_ORIGINS=http://localhost:5173,https://yourdomain.com
MAX_FILE_SIZE=10485760 # 10MB
#Usage
- Upload CV: Select and upload your PDF resume
- Processing: Wait for AI analysis (usually 30-60 seconds)
- Review Results: Get your roasted review with:
- Overall score
- Section-wise feedback
- Improvement suggestions
- Humorous but constructive comments
#API Endpoints
POST /api/upload
- Upload CV fileGET /api/review/{review_id}
- Get review status/resultsGET /api/health
- Health check
#Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
#License
MIT License - feel free to use this project for your own purposes.
#Support
If you encounter any issues or have questions:
- Open an issue on GitHub
- Check the API documentation at
/docs
- Review the troubleshooting section below
#Troubleshooting
Common Issues:
- PDF parsing errors: Ensure PDF is text-selectable
- API timeouts: Check DeepSeek API status
- Upload failures: Verify file size under 10MB
Performance Tips:
- Use PDF files under 5MB for faster processing
- Ensure good internet connection for API calls
- Clear browser cache if UI issues persist
Made with β€οΈ and a bit of sass π₯