Files
moneymind/README.md
2025-08-13 15:28:44 +02:00

6.7 KiB

Next.js Better Auth PostgreSQL Starter Kit

A complete Next.js boilerplate with authentication, PostgreSQL database, AI chat functionality, and modern UI components - perfect for building your next SaaS application.

🚀 Features

  • 🔐 Authentication: Better Auth with Google OAuth integration
  • 🗃️ Database: Drizzle ORM with PostgreSQL
  • 🤖 AI Integration: Vercel AI SDK with OpenAI support
  • 🎨 UI Components: shadcn/ui with Tailwind CSS
  • Modern Stack: Next.js 15, React 19, TypeScript
  • 📱 Responsive: Mobile-first design approach

📋 Prerequisites

Before you begin, ensure you have the following installed on your machine:

  • Node.js: Version 18.0 or higher (Download here)
  • Git: For cloning the repository (Download here)
  • PostgreSQL: Either locally installed or access to a hosted service like Vercel Postgres

🛠️ Quick Setup

1. Clone or Download the Repository

Option A: Clone with Git

git clone https://github.com/your-username/nextjs-better-auth-postgresql-starter-kit.git
cd nextjs-better-auth-postgresql-starter-kit

Option B: Download ZIP Download the repository as a ZIP file and extract it to your desired location.

2. Install Dependencies

npm install

3. Environment Setup

Copy the example environment file:

cp env.example .env

Fill in your environment variables in the .env file:

# Database
POSTGRES_URL="postgresql://username:password@localhost:5432/your_database_name"

# Authentication - Better Auth
BETTER_AUTH_SECRET="your-random-32-character-secret-key-here"

# Google OAuth (Get from Google Cloud Console)
GOOGLE_CLIENT_ID="your-google-client-id"
GOOGLE_CLIENT_SECRET="your-google-client-secret"

# AI Integration (Optional - for chat functionality)
OPENAI_API_KEY="sk-your-openai-api-key-here"
OPENAI_MODEL="gpt-5-mini"

# App URL (for production deployments)
NEXT_PUBLIC_APP_URL="http://localhost:3000"

4. Database Setup

Push the database schema to your PostgreSQL database:

npm run db:push

5. Start the Development Server

npm run dev

Your application will be available at http://localhost:3000

⚙️ Service Configuration

PostgreSQL Database on Vercel

  1. Go to Vercel Dashboard
  2. Navigate to the Storage tab
  3. Click CreatePostgres
  4. Choose your database name and region
  5. Copy the POSTGRES_URL from the .env.local tab
  6. Add it to your .env file

Google OAuth Credentials

  1. Go to Google Cloud Console
  2. Create a new project or select an existing one
  3. Enable the Google+ API
  4. Navigate to CredentialsCreate CredentialsOAuth 2.0 Client ID
  5. Set application type to Web application
  6. Add authorized redirect URIs:
    • http://localhost:3000/api/auth/callback/google (development)
    • https://yourdomain.com/api/auth/callback/google (production)
  7. Copy the Client ID and Client Secret to your .env file

OpenAI API Key

  1. Go to OpenAI Platform
  2. Navigate to API Keys in the sidebar
  3. Click Create new secret key
  4. Give it a name and copy the key
  5. Add it to your .env file as OPENAI_API_KEY

🗂️ Project Structure

src/
├── app/                    # Next.js app directory
│   ├── api/               # API routes
│   │   ├── auth/          # Authentication endpoints
│   │   └── chat/          # AI chat endpoint
│   ├── chat/              # AI chat page
│   ├── dashboard/         # User dashboard
│   └── page.tsx           # Home page
├── components/            # React components
│   ├── auth/             # Authentication components
│   └── ui/               # shadcn/ui components
└── lib/                  # Utilities and configurations
    ├── auth.ts           # Better Auth configuration
    ├── auth-client.ts    # Client-side auth utilities
    ├── db.ts             # Database connection
    ├── schema.ts         # Database schema
    └── utils.ts          # General utilities

🔧 Available Scripts

npm run dev          # Start development server with Turbopack
npm run build        # Build for production
npm run start        # Start production server
npm run lint         # Run ESLint
npm run db:generate  # Generate database migrations
npm run db:migrate   # Run database migrations
npm run db:push      # Push schema changes to database
npm run db:studio    # Open Drizzle Studio (database GUI)
npm run db:dev       # Push schema for development
npm run db:reset     # Reset database (drop all tables)

📖 Pages Overview

  • Home (/): Landing page with setup instructions and features overview
  • Dashboard (/dashboard): Protected user dashboard with profile information
  • Chat (/chat): AI-powered chat interface using OpenAI (requires authentication)

🚀 Deployment

  1. Push your code to GitHub
  2. Connect your repository to Vercel
  3. Add your environment variables in the Vercel dashboard
  4. Deploy automatically with each push to your main branch

Production Environment Variables

Ensure these are set in your production environment:

  • POSTGRES_URL - Production PostgreSQL connection string
  • BETTER_AUTH_SECRET - Secure random 32+ character string
  • GOOGLE_CLIENT_ID - Google OAuth Client ID
  • GOOGLE_CLIENT_SECRET - Google OAuth Client Secret
  • OPENAI_API_KEY - OpenAI API key (optional)
  • OPENAI_MODEL - OpenAI model name (optional, defaults to gpt-5-mini)
  • NEXT_PUBLIC_APP_URL - Your production domain

🎥 Tutorial Video

Watch my comprehensive tutorial on how to use this boilerplate to build amazing applications:

📺 YouTube Tutorial - Building with Next.js Better Auth PostgreSQL Starter Kit

Coming soon - link will be updated with the actual video URL

🤝 Contributing

  1. Fork this repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Need Help?

If you encounter any issues:

  1. Check the Issues section
  2. Review the documentation above
  3. Create a new issue with detailed information about your problem

Happy coding! 🚀