How tabarakmukhtar/smart-ai-resume-analyzer works
Project type and purpose
• This is a monolithic, full-stack Python web application built on Streamlit, designed to let users upload or build a resume, analyze it with NLP/ML models, get ATS scores, keyword gaps, and AI-driven suggestions, then download or export the optimized resume.
File structure
• app.py – the Streamlit entrypoint (UI + request router).
• config/ – database connections (SQLite), course and job-role definitions.
• dashboard/ – Streamlit dashboard components (charts, insights).
• feedback/ – feedback database + UI for user comments.
• jobs/ – job-search, portal integration, suggestions.
• resume_analytics/ + utils/resume_analyzer.py – core resume analysis logic (standard + AI).
• utils/resume_parser.py, resume_builder.py – parsing uploaded PDF/Word, building new resumes.
• utils/excel_manager.py – openpyxl exports.
• style/ + assets/ – CSS and static assets for UI theming.
• resume_data.db / feedback.db – SQLite storage for resumes, feedback, usage stats.
• Dockerfile / .devcontainer – containerization for dev & deploy.
Key architectural patterns and components
• Single process Monolith with modular code packages.
• MVC-style separation:
• View: Streamlit scripts & ui_components.py
• Controller: app.py routing + dashboard/ + feedback/ + jobs/
• Model: config/database.py + utils/database.py + SQLite DBs.
• Plugin-like modules for NLP/ML: spaCy, scikit-learn, NLTK, PyPDF2, python-docx, openpyxl.
Main components & interactions (
a. Frontend (Streamlit UI)
• Components: app.py, dashboard/dashboard.py, dashboard/components.py, ui_components.py, style/style.css
• Renders pages: Home, Resume Analyzer, Builder, Dashboard, Job Search, Feedback, About
b. Backend logic
• Resume Parser & Uploader (utils/resume_parser.py)
• Standard Analyzer (resume_analytics/analyzer.py + utils/resume_analyzer.py)
• AI-Powered Analyzer (utils/resume_analyzer.py invoking external AI or local ML)
• Resume Builder (utils/resume_builder.py + template modules)
• Job Search & Suggestions (jobs/*)
• Feedback Handler (feedback/feedback.py + feedback.db)
c. Data Layer
• SQLite databases: resume_data.db, feedback.db, resume_analysis.db
• Tables for resumes, analysis results, user feedback
d. External Services & Libraries
• spaCy, NLTK for NLP
• scikit-learn for ML models
• PyPDF2, python-docx for file parsing/generation
• openpyxl for Excel export
• (Optional) Google Gemini via API key for AI in Version 2.0
e. Deployment / DevOps
• Docker container (Dockerfile)
• VS Code remote container (.devcontainer.json)
Relationships & data flows
• User → Streamlit UI → Upload/Fill Resume
• UI calls Parser → Extract text → Pass to Analyzer module(s)
• Analyzer reads/writes to resume_analysis.db
• Analyzer returns results → UI renders charts (Plotly) & recommendations
• User selects builder templates → Builder module generates Word/PDF → Download
• Job Search UI → jobs/* modules call external portals → suggestions → UI
• Feedback UI → feedback module writes to feedback.db → Admin Dashboard reads feedback
• Dashboard module reads all DBs → aggregates metrics → displays to admin
Architectural patterns & design principles
• Modular separation by feature area (config, dashboard, jobs, feedback, analytics, utils)
• Single responsibility per module
• Clear controller logic in app.py that routes user events to feature modules
• Data-access layer abstracted in utils/database.py & config/database.py
• Reusable UI components in ui_components.py
• Component names: “Streamlit UI”, “Resume Parser”, “Standard Analyzer”, “AI Analyzer”, “Resume Builder”, “Job Search Engine”, “Feedback Handler”, “Dashboard Aggregator”, “SQLite DBs”
• Technology labels: Python, Streamlit, SQLite, spaCy, scikit-learn, PyPDF2, python-docx, openpyxl, NLTK
• Environment boundary: “Docker Container” surrounding all internal components