CVNalys 🚀

CVNalys is a modern, high-converting web application that helps users analyze their CVs using advanced AI technology. Upload your CV and receive professional insights, skill analysis, and actionable recommendations to make your resume stand out.

• AI-Powered Analysis: Advanced machine learning algorithms provide deep insights
• Multi-Format Support: PDF, DOCX, DOC, TXT, RTF files supported
• Instant Results: Get comprehensive analysis in seconds
• Privacy First: Your CV is never stored on our servers
• No Login Required: Start analyzing immediately
• Mobile Responsive: Beautiful UI that works on all devices
• Touch Gestures: Hammer.js integration for mobile interactions

• Python 3.11 or higher
• pip package manager
• OpenAI API key (optional, for AI analysis)

git clone https://github.com/OpenAI4Africa/CVNalys.git
cd cvnalys

# Create virtual environment
python3 -m venv venv

# Activate virtual environment
source venv/bin/activate          # On macOS/Linux
# OR
venv\Scripts\activate             # On Windows

pip install -r requirements.txt

# Copy environment template
cp env.example .env

# Edit .env file with your settings
nano .env  # or use your preferred editor

python run.py

Create a .env file in the root directory with the following configuration:

# 🔑 Required Settings
SECRET_KEY=your-super-secret-key-here

# 🤖 Optional - OpenAI API for AI analysis
OPENAI_API_KEY=your-openai-api-key-here

# 📁 Optional - File upload settings
MAX_FILE_SIZE=16777216  # 16MB in bytes

💡 Pro Tip: The application works without an OpenAI API key, but AI-powered analysis and CV rewriting features will be limited.

cvnalys/
├── 🚀 app/                          # Main application package
│   ├── __init__.py                  # Flask app factory & configuration
│   ├── routes.py                    # API endpoints & request handling
│   ├── 🔧 services/
│   │   └── cv_analyzer.py          # AI-powered CV analysis service
│   ├── 🛠️ utils/
│   │   ├── file_processor.py       # Multi-format file processing
│   │   └── report_generator.py     # PDF/TXT report generation
│   ├── 🎨 static/
│   │   ├── css/
│   │   │   └── style.css           # Professional Tailwind CSS styles
│   │   ├── js/
│   │   │   └── app.js              # Interactive JavaScript application
│   │   └── images/                 # SISU AI branding assets
│   └── 📄 templates/
│       └── index.html              # Main application interface
├── 📁 uploads/                      # Temporary file storage (auto-created)
├── 🐍 venv/                        # Python virtual environment
├── 📦 requirements.txt              # Python dependencies
├── 🚀 run.py                       # Application entry point
├── ⚙️ env.example                  # Environment variables template
├── 📖 README.md                    # This documentation
└── 📄 LICENSE                      # Apache 2.0 License

• 📊 CV Score (0-100): Professional assessment with visual progress indicator
• 📝 Word Count & Structure: Detailed text analysis and formatting insights
• 🛠️ Skills Identification: Categorized technical and soft skills detection
• 💡 Actionable Recommendations: Specific improvement suggestions
• 🤖 AI-Powered Insights: Advanced analysis using OpenAI GPT-4 (with API key)

Format	Extension	Description	Best Quality
	.pdf	Portable Document Format	High-quality scans
	.docx, .doc	Microsoft Word documents	Modern Word format
	.txt	Plain text documents	UTF-8 encoding
	.rtf	Rich Text Format	Formatted text

• 📏 Maximum Size: 16MB per file
• 🔤 Encoding: UTF-8 recommended for text files
• 🎯 Quality: Higher quality PDFs provide better text extraction
• 🔄 Processing: Files are processed in memory and never stored

• ❌ Store your CV files on our servers
• ❌ Track your personal information
• ❌ Share your data with third parties
• ❌ Require account creation or login

• ✅ Process files securely in memory
• ✅ Provide immediate analysis results
• ✅ Generate downloadable reports
• ✅ Maintain complete user privacy

# Install development dependencies
pip install pytest black flake8

# 🧪 Run tests
pytest

# 🎨 Code formatting
black app/

# 🔍 Linting
flake8 app/

• 🐍 PEP 8 Compliance: Follow Python style guide standards
• 🔍 Type Hints: Use type annotations where appropriate
• 📚 Documentation: Document all functions and classes
• ⚡ Function Design: Keep functions small, focused, and efficient

# Clone and setup
git clone https://github.com/OpenAI4Africa/CVNalys.git
cd cvnalys

# Create virtual environment
python3 -m venv venv
source venv/bin/activate

# Install development dependencies
pip install -r requirements.txt
pip install pytest black flake8

# Run development server
python run.py

Platform	Difficulty	Best For	Setup Time
	Easy	Quick prototypes	5 minutes
	Medium	Scalable deployments	15 minutes
	Advanced	Enterprise solutions	30 minutes
	Medium	Full control	20 minutes

• ✅ Environment variables configured
• ✅ Dependencies installed
• ✅ File permissions set correctly
• ✅ CORS settings configured
• ✅ Security headers implemented
• ✅ Error logging enabled
• ✅ Health check endpoint working

CVNalys is an open-source project and we'd love your help to make it even better. Whether you're a developer, designer, or just passionate about AI and CV analysis, there are many ways to contribute.

• 🚀 New Features: CV templates, industry-specific analysis
• 🐛 Bug Fixes: Identify and fix issues
• 📚 Documentation: Improve guides and examples
• 🎨 UI/UX: Enhance the user interface
• 🌍 Localization: Add support for more languages
• 🧪 Testing: Improve test coverage

1. Star this repository if you find it useful
2. Fork the project to your GitHub account
3. Clone your fork locally
4. Create a new branch for your changes
5. Make your improvements
6. Test everything works
7. Submit a pull request

• 💬 Discussions: Start a discussion in GitHub Discussions
• 🐛 Issues: Report bugs or request features
• 📧 Email: Contact us at hello@openai4africa.org

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for complete details.

• ✅ Commercial Use: Allowed
• ✅ Modification: Allowed
• ✅ Distribution: Allowed
• ✅ Patent Use: Allowed
• ✅ Private Use: Allowed

• 📝 License and Copyright Notice: Must be included
• ⚠️ State Changes: Must be documented
• 📄 Apache License: Must be included in any distribution

For the complete license text, please see the LICENSE file in this repository.

Technology	Purpose	Website
	AI analysis capabilities	openai.com
	Web framework	flask.palletsprojects.com
	Beautiful UI components	tailwindcss.com
	Professional icons	fontawesome.com
	Mobile touch support	hammerjs.github.io

This project was inspired by the need to democratize AI-powered CV analysis and make professional career development tools accessible to everyone, especially in emerging markets.

• 🌐 General Inquiries: hello@openai4africa.org
• 🔧 Open Source Support: os@openai4africa.org
• 🌍 Website: openai4africa.org
• 💼 LinkedIn: OpenAI4Africa

• 🌐 Website: sisuai.com
• 🔧 Development Support: dev@sisuai.com
• 🔧 Open Source Support: os@sisuai.com
• 💼 LinkedIn: SISU AI

1. 📖 Check the documentation - Your answer might be here
2. 🔍 Search existing issues - Someone might have asked already
3. 📝 Provide details - Include error messages, steps to reproduce
4. 💻 Share your environment - OS, Python version, etc.

• ☑️ Be respectful and inclusive
• ☑️ Help others when you can
• ☑️ Share your experiences and use cases
• ☑️ Report bugs and suggest improvements

• ✅ Core CV analysis functionality
• ✅ AI-powered insights
• ✅ Multi-format file support
• ✅ Professional UI/UX design
• 🔄 Performance optimizations
• 🔄 Enhanced error handling

• 📄 Advanced CV templates
• 🏭 Industry-specific analysis
• 📊 ATS optimization scoring
• 🔍 Resume comparison tools
• 📱 Progressive Web App (PWA)
• 🌍 Multi-language support

• 📤 Export to multiple formats
• 👥 Team collaboration features
• 📊 Advanced analytics dashboard
• 🔗 API for third-party integrations
• 🎓 Learning management system
• 🌐 Global deployment optimization

We'd love to hear your feature requests! Please:

• 🐛 Create an issue with the enhancement label
• 💬 Start a discussion in GitHub Discussions
• 📧 Email us at hello@openai4africa.org