63 lines
2.5 KiB
Markdown
63 lines
2.5 KiB
Markdown
# Sanctum App - Project Structure
|
|
|
|
## Overview
|
|
|
|
Next.js 15 application bootstrapped with OpenNext for Cloudflare Workers deployment. Currently in initial setup phase with default Next.js starter template.
|
|
|
|
## Project Root Files
|
|
|
|
- **[README.md](./README.md)** - OpenNext starter documentation and deployment instructions
|
|
- **[package.json](./package.json)** - Project dependencies including Next.js, OpenNext Cloudflare adapter, shadcn/ui components
|
|
- **[pnpm-lock.yaml](./pnpm-lock.yaml)** - PNPM dependency lock file
|
|
- **[components.json](./components.json)** - shadcn/ui component configuration
|
|
- **[tsconfig.json](./tsconfig.json)** - TypeScript compiler configuration
|
|
- **[cloudflare-env.d.ts](./cloudflare-env.d.ts)** - Cloudflare environment type definitions
|
|
- **[.gitignore](./.gitignore)** - Git ignore patterns for build artifacts and dependencies
|
|
- **[.dev.vars.example](./.dev.vars.example)** - Example environment variables template
|
|
- **[.dev.vars](./.dev.vars)** - Local development environment variables (not tracked)
|
|
|
|
## Application Source
|
|
|
|
### src/app/
|
|
|
|
- **[layout.tsx](./src/app/layout.tsx)** - Root layout component with Geist font configuration
|
|
- **[page.tsx](./src/app/page.tsx)** - Homepage component with Next.js default landing page
|
|
|
|
### src/lib/
|
|
|
|
- **[utils.ts](./src/lib/utils.ts)** - Utility functions including Tailwind class merging helpers
|
|
|
|
## Configuration
|
|
|
|
### .vscode/
|
|
|
|
- **[settings.json](./.vscode/settings.json)** - VS Code workspace settings
|
|
|
|
## Build Output
|
|
|
|
- **.next/** - Next.js build output directory (ignored by git)
|
|
- Contains compiled application, cache, and server bundles
|
|
- Includes standalone build for Cloudflare Workers deployment
|
|
|
|
## Technology Stack
|
|
|
|
**Framework:** Next.js 15.5.7 with App Router
|
|
**Runtime:** React 19.1.2
|
|
**Deployment:** OpenNext Cloudflare adapter for Workers
|
|
**Styling:** Tailwind CSS 4.x with PostCSS
|
|
**UI Components:** shadcn/ui with class-variance-authority, clsx, lucide-react
|
|
**Language:** TypeScript 5.x
|
|
**Package Manager:** PNPM
|
|
**Development:** Turbopack for fast dev server
|
|
|
|
## Available Scripts
|
|
|
|
- `pnpm dev` - Start Next.js development server with Turbopack
|
|
- `pnpm build` - Build Next.js application
|
|
- `pnpm start` - Start production Next.js server
|
|
- `pnpm lint` - Run ESLint code quality checks
|
|
- `pnpm deploy` - Build and deploy to Cloudflare Workers
|
|
- `pnpm upload` - Build and upload to Cloudflare (no deployment)
|
|
- `pnpm preview` - Build and preview locally on Cloudflare runtime
|
|
- `pnpm cf-typegen` - Generate Cloudflare environment TypeScript types
|