How hack-smiths/portfolia works
Project type and purpose
• This is a full-stack web application called “Portfolia” that lets users import GitHub internship/project repos, parse resume PDFs, enhance content with AI, and build/export a polished portfolio.
• Frontend: React + TypeScript (Vite) with TailwindCSS & ShadCN-style components.
• Backend: FastAPI (Python) with SQLAlchemy + PostgreSQL, integrates with GitHub’s REST API and an LLM service (OpenAI or similar).
File structure
• Top-level:
• frontend/ – all React UI code (public assets, pages, reusable UI components, hooks, utils, routing)
• backend/ – Python API (app/main.py, app/api/v1/routes, app/crud, app/schemas)
• requirements.txt, package.json, README.md, .env (GitHub token), venv folder for dependencies
• Backend layers:
• Routes (github.py, project.py) define HTTP endpoints under /api/v1
• CRUD layer encapsulates database operations for GitHub-imported entities
• Schemas define Pydantic models for request/response validation
• main.py wires routes, middleware, DB session, and config
• Frontend architecture:
• Pages under src/pages map to routes (Dashboard, Projects, Achievements, etc.)
• components/ holds both domain components (FileUpload, Navbar, dialogs) and a ui/ design system
• hooks/ for shared logic; utils/ for helper functions; App.tsx mounts React Router
README for additional insights
• Tech stack summary confirms API auth via GitHub token in .env, LLM integration pending
• Lists feature set: GitHub import, AI enhancements, PDF upload & parsing, live portfolio preview, PDF export