README Template for Next.js Projects

# Project Name

Brief description of what this app does.

## Tech Stack

- Next.js 15
- React 19
- TypeScript
- Tailwind CSS

## Getting Started

```bash
git clone https://github.com/your-username/your-project.git
cd your-project
npm install
npm run dev
```

Open [http://localhost:3000](http://localhost:3000) in your browser.

## Environment Variables

Copy the example file and fill in your values:

```bash
cp .env.example .env.local
```

| Variable | Description | Required |
|----------|-------------|----------|
| `DATABASE_URL` | PostgreSQL connection string | Yes |
| `NEXTAUTH_SECRET` | Auth encryption key | Yes |
| `NEXTAUTH_URL` | App URL | Yes |

## Project Structure

```
src/
  app/           # App Router pages and layouts
  components/    # Reusable components
  lib/           # Server utilities
  styles/        # Global CSS
```

## Scripts

| Script | Description |
|--------|-------------|
| `npm run dev` | Start development server |
| `npm run build` | Build for production |
| `npm start` | Start production server |
| `npm run lint` | Run ESLint |

## Deployment

Deploy on [Vercel](https://vercel.com):

```bash
npm i -g vercel
vercel
```

## Licence

MIT