Skip to content

QUICK_START.md

Latest commit

 

History

History
78 lines (59 loc) · 1.71 KB

QUICK_START.md

File metadata and controls

78 lines (59 loc) · 1.71 KB

Quick Start Guide

Prerequisites

  • Node.js 18 or higher
  • npm, yarn, or pnpm

Setup Instructions

  1. Clone and install dependencies
npm install
  1. Set up environment variables
cp .env.example .env
# Edit .env and add your AUTH_SECRET
  1. Initialize the database
npx prisma migrate dev
# or
npx prisma db push
  1. Start the development server
npm run dev
  1. Open your browser Navigate to http://localhost:3000

First Steps

  1. Click "Create Account" on the homepage
  2. Fill in your name, email, and password (min 6 characters)
  3. You'll be automatically logged in and redirected to the dashboard
  4. Explore the protected dashboard area

Building for Production

npm run build
npm start

Common Commands

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm start - Start production server
  • npm run lint - Run ESLint
  • npx prisma studio - Open Prisma Studio (database GUI)
  • npx prisma migrate dev - Create a new migration

Troubleshooting

Database errors?

  • Make sure you've run npx prisma db push or npx prisma migrate dev
  • Check that DATABASE_URL in .env is correct

Authentication not working?

  • Ensure AUTH_SECRET is set in .env
  • Try clearing your browser cookies

Build errors?

  • Delete .next folder and node_modules
  • Run npm install and npm run build again

Need Help?