Sunbeam

Sunbeam is a modern web application built with Next.js, designed as a robust, full-featured Inventory Management (library and account management) platform. It leverages the latest Next.js App Router, server components, and integrates with Supabase for authentication and data storage. The project is structured for scalability, maintainability, and developer productivity.

Features

• User Authentication: Secure login, sign-out, and account confirmation flows using Supabase Auth.
• Library Management: Add, edit, and manage books or documents in a user-friendly interface.
• Dashboard: Visualize statistics and manage your library from a central dashboard.
• Responsive UI: Modern, accessible, and responsive design using custom UI components.
• API Routes: RESTful API endpoints for library and account operations.
• Theming: Light/dark mode and theme selection support.
• Prisma ORM: Type-safe database access and migrations (if enabled).

Project Structure

• app/ — Main Next.js app directory (routing, pages, API endpoints)
• components/ — Reusable UI and layout components
• hooks/ — Custom React hooks
• lib/ — Utility libraries (Prisma, Supabase helpers, etc.)
• public/ — Static assets
• utils/ — Additional utilities and integrations
• prisma/ — Prisma schema and migrations

Technologies Used

• Next.js (App Router, Server Components)
• Supabase (Auth, Database)
• Prisma ORM (optional, for advanced DB access)
• TypeScript
• ESLint & Prettier (code quality)

Getting Started

1. Install dependencies:

   npm install
   # or
   yarn install

2. Set up environment variables:
   • Copy .env.example to .env.local and fill in your Supabase/Prisma credentials.
3. Run the development server:

   npm run dev
   # or
   yarn dev

   Open http://localhost:3000 to view the app.

Code Documentation

• All exported functions and modules are documented with JSDoc/TSDoc comments for clarity and maintainability.
• See lib/, utils/, and components/ for detailed code documentation.

Deployment

Deploy easily on Vercel or any platform supporting Next.js. See Next.js deployment docs.

© 2025 Sunbeam Project. Built with Next.js and Supabase.