How joshua-sx/pjiae-360 works
Project Type and Purpose
• This is a single-page, full-stack web application—specifically the front-end of a digital employee appraisal platform (“Smartgoals 360”) built with React, TypeScript and Vite.
• It demonstrates an onboarding flow, dashboards, goal and appraisal management, authentication via Clerk, and client-side data fetching/caching with React Query.
File Structure
• Top-level files:
• index.html (Vite entry point)
• package.json, bun.lockb, tsconfig*.json, vite.config.ts (build, lint and type configurations)
• public/ (static assets, robots.txt)
• src/ subdirectories:
• components/ – all UI pieces, subdivided into page-level components (LandingPage, DashboardLayout, AppraisalsPage, etc.), domain modules (appraisals/, goals/, onboarding/, preview/), and a shared UI library (ui/ based on shadcn + Tailwind).
• pages/ – route entry components (Index.tsx, NotFound.tsx).
• hooks/ and contexts/ – custom React hooks (useRole, usePreviewSync, etc.) and context providers (PreviewContext).
• lib/ – API wrapper (api.ts) and utilities.
• types/ – shared TypeScript definitions.
• Configuration for ESLint, PostCSS, Tailwind, Vite.
Key Insights from the README
• Authentication: Clerk handles sign-in, user sessions.
• Data fetching: React Query for HTTP calls and caching.
• CSS: Tailwind + shadcn UI component library.
• Demo data: some modules use mockData.ts for previews.