How qiushizhou/resumeapi works
Project type and purpose
• This is a full-stack, AI-powered resume optimization platform.
• Frontend: React/TypeScript single-page application served via Nginx.
• Backend: Flask microservice exposing RESTful APIs for parsing, analyzing, optimizing, and PDF generation.
• AI integration: OpenAI GPT models for content optimization.
• Data stores: file upload directory (volume) and optional MongoDB for persistence.
File structure
• Top level:
• docker-compose.yml orchestrates two services (resume-frontend, resume-backend).
• .github/workflows contains CI/CD pipeline for build and push.
• resume-frontend:
• Dockerfile + nginx.conf serve compiled React app.
• src/components implements UI (Auth, Resume editor, preview, controls).
• services/api.ts handles Axios calls to backend.
• resume_backend:
• Dockerfile and app.py as the entrypoint.
• resume_parser.py, resume_analyzer.py, resume_pdf_generator.py implement core logic.
• swagger_config.py / swagger_docs.py expose API docs.
• test_*.py for unit tests.
• uploads/ directory mounted as volume for incoming PDF/Docx.
README for additional insights
• Confirms core user flows: drag-and-drop editing, AI optimization per section, job-target matching, export as PDF.
• Technology stack reinforces: React + Material-UI + Flask + OpenAI + MongoDB (optional).
• Deployment guide shows that containers run behind Nginx (frontend) and Flask on 8080 (backend).
Elements
• Blue for user/client layers
• Green for service containers
• Orange for data stores/volumes
• Purple for external dependencies (OpenAI, CI/CD)