From cdc3fd47c01291dcf3e3bc6f4aba76039b168260 Mon Sep 17 00:00:00 2001 From: Shivansh Date: Sun, 14 Dec 2025 17:36:12 +0530 Subject: [PATCH 1/2] fix: describe what you fixed --- frontend/STRUCTURE.md | 52 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 frontend/STRUCTURE.md diff --git a/frontend/STRUCTURE.md b/frontend/STRUCTURE.md new file mode 100644 index 0000000..4e90f31 --- /dev/null +++ b/frontend/STRUCTURE.md @@ -0,0 +1,52 @@ +# Frontend Code Structure + +This document describes the key folders and files inside the `frontend/` directory. + +## Quick start +- Install: `npm i` +- Run locally: `npm run dev` (opens at http://localhost:3000) + +## Top-level files +- `package.json`: project scripts and dependencies. +- `next.config.ts`, `tsconfig.json`: Next.js and TypeScript configs. +- `components.json`: shadcn/ui config and path aliases (e.g. `@/components`, `@/lib/utils`). + +## Directory layout + +- `app/` + - `page.tsx` — main route `/`. + - `layout.tsx` — application layout wrapper. + - `globals.css` — Tailwind/CSS reset and global styles referenced by `components.json`. + - `demo/page.jsx` — demos or example page at `/demo`. + +- `components/` + - `header.tsx`, `hero-section.tsx` — top-level shared components. + - `ui/` — small, reusable UI elements (buttons, dropdowns, textarea, theme toggle, animated background, etc.). + +- `lib/` + - `utils.ts` — shared helper functions. + +- `public/` — static assets (SVGs, images) served at the root. + +## Styling & UI +- Tailwind CSS is used (see `app/globals.css` and `components.json` Tailwind settings). +- `components.json` defines aliases and UI registry settings used by the `shadcn` tooling. + +## Import aliases +The project uses path aliases from `components.json`; examples: + +- `@/components` → `components/` +- `@/lib/utils` → `lib/utils.ts` + +Example import: + +```ts +import Header from '@/components/header' +import { format } from '@/lib/utils' +``` + +## Notes +- Routes use the Next.js App Router (`app/` directory). +- Keep small, generic controls inside `components/ui/` and page-specific components at top-level `components/`. + +If you want, I can also add this doc to `docs/` and link it from the repo README. From 517354f049101f2569682ce21391b8a300b1b056 Mon Sep 17 00:00:00 2001 From: Shivansh Date: Sun, 14 Dec 2025 17:44:55 +0530 Subject: [PATCH 2/2] fix: describe what you fixed --- frontend/STRUCTURE.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/frontend/STRUCTURE.md b/frontend/STRUCTURE.md index 4e90f31..3ebb8eb 100644 --- a/frontend/STRUCTURE.md +++ b/frontend/STRUCTURE.md @@ -4,7 +4,7 @@ This document describes the key folders and files inside the `frontend/` directo ## Quick start - Install: `npm i` -- Run locally: `npm run dev` (opens at http://localhost:3000) ++ Run locally: `npm run dev` (opens at `http://localhost:3000`) ## Top-level files - `package.json`: project scripts and dependencies. @@ -48,5 +48,3 @@ import { format } from '@/lib/utils' ## Notes - Routes use the Next.js App Router (`app/` directory). - Keep small, generic controls inside `components/ui/` and page-specific components at top-level `components/`. - -If you want, I can also add this doc to `docs/` and link it from the repo README.