How hirementis-dev/hirementis-frontend works
Project type and purpose
• This is a Next.js-based full-stack web application (“Hirementis – AI Interview Platform”).
• Purpose: Provide users with AI-driven mock interviews for real job listings, secure login, interview simulation, feedback reporting, and profile management.
File structure
• Top-level directories:
• app/ – Next.js App Router structure (pages, layouts, API routes)
• pages/ – Legacy Next.js Pages Router (coexists during migration)
• components/ – Reusable UI and feature components, organized by domain (e.g. interview-feedback, ui)
• lib/ – Core business logic and SDK wrappers (OpenAI, vapi, auth actions)
• firebase/ – Auth and database client setup (admin.ts, client.ts, actions.ts)
• hooks/ – Custom React hooks for fetching feedback, user profiles, auth state
• data/ – Static data (job listings)
• utils/ – Utility functions (formatting, CSV export, vapi prompt templates)
• public/ – Static assets (intro.mp4)
• types/ – TypeScript type definitions
• Key configuration/build files: next.config.ts, tsconfig.json, eslint.config.mjs, postcss.config.mjs, package.json.
Extract architectural insights from README
• Interactive multi-section homepage, jobs browsing, secure login, interview flows, feedback dashboard.
• Real-time job data, AI callouts for question generation and feedback (via OpenAI & custom vapi).
• Temporary “secret key” gate during launch.
• Persistent data for users and interview history (likely stored in Firebase).
Main components & their interactions
a. Frontend (Client Browser / Mobile)
• Next.js App Router (app/) serving React Server and Client Components
• UI components (Navbar, HeroSection, Interview pages, Profile dashboard)
b. API Layer (Next.js Serverless Functions in app/api/)
• /generate-question → calls OpenAI/vapi SDK
• /generate-feedback → processes interview answers, returns feedback
• /interviews → CRUD interview records in Firebase
• /upload-imagekit → proxy for ImageKit uploads
c. Business Logic & SDKs (lib/)
• Auth.action.ts connects to Firebase Auth
• openai.sdk.ts, vapi.sdk.ts wrap external AI services
• utils.ts for shared utilities
d. Data Layer
• Firebase Auth (user sign-in, secret key gating)
• Firebase Firestore or Realtime DB (interview records, user profiles)
• ImageKit (avatar, resume, social links uploads)
• Static data/jobs.ts for job listings fallback
e. External Services
• OpenAI API for question/feedback generation
• Vapi API (custom prompt workflows)
• ImageKit for file storage
• Potential analytics or monitoring (not shown, but common)
Architectural patterns & design principles
• Component-based UI (Atomic/UI, feature-specific components)
• File-based routing (Next.js App & Pages routers)
• Serverless API endpoints (Next.js functions)
• Separation of concerns: UI ↔ API ↔ Business Logic ↔ Data Layer
• Hybrid rendering: SSR for public pages, client-side fetching for dynamic interview sessions
• Secure data flow: Auth guard on protected routes (app/(auth))