Skip to content

VERCEL_DEPLOYMENT_CHECKLIST.md

Latest commit

 

History

History
392 lines (323 loc) · 9.9 KB

VERCEL_DEPLOYMENT_CHECKLIST.md

File metadata and controls

392 lines (323 loc) · 9.9 KB

SOHAM - Vercel Deployment Checklist

Pre-Deployment Checklist

Code Preparation

  • All changes committed to git
  • Code pushed to GitHub main branch
  • No TypeScript errors (npm run typecheck)
  • No ESLint errors (npm run lint)
  • Build succeeds locally (npm run build)
  • App runs locally (npm run dev)

Environment Variables Ready

  • GROQ_API_KEY - Groq API key
  • NEXT_PUBLIC_FIREBASE_API_KEY - Firebase API key
  • NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN - Firebase auth domain
  • NEXT_PUBLIC_FIREBASE_PROJECT_ID - Firebase project ID
  • NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET - Firebase storage bucket
  • NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID - Firebase sender ID
  • NEXT_PUBLIC_FIREBASE_APP_ID - Firebase app ID
  • Optional: CEREBRAS_API_KEY - Cerebras fallback
  • Optional: GOOGLE_API_KEY - Google AI fallback
  • Optional: HUGGINGFACE_API_KEY - HuggingFace fallback
  • Optional: NEXT_PUBLIC_ELEVENLABS_API_KEY - ElevenLabs TTS

Configuration Files

  • vercel.json exists and configured
  • .vercelignore exists
  • next.config.js is Vercel-compatible
  • package.json has correct scripts
  • .env.local is in .gitignore (security)

Deployment Steps

Step 1: Vercel Account Setup

  • Created Vercel account
  • Connected GitHub account
  • Verified email address

Step 2: Import Project

  • Clicked "Add New Project" in Vercel
  • Selected CODEEX-AI repository
  • Framework detected as Next.js
  • Root directory set to ./

Step 3: Configure Build Settings

  • Build Command: npm run build (auto-detected)
  • Output Directory: .next (auto-detected)
  • Install Command: npm install (auto-detected)
  • Node.js Version: 18.x or higher

Step 4: Add Environment Variables

  • Clicked "Environment Variables" section
  • Added all required variables
  • Set variables for: Production, Preview, Development
  • Verified no typos in variable names
  • Verified no extra spaces in values

Step 5: Deploy

  • Clicked "Deploy" button
  • Waited for build to complete (2-3 minutes)
  • Build succeeded without errors
  • Received deployment URL

Step 6: Post-Deployment Configuration

  • Copied Vercel deployment URL
  • Updated NEXT_PUBLIC_APP_URL in Vercel settings
  • Triggered redeploy with new URL
  • Added Vercel domain to Firebase authorized domains

Verification Checklist

Basic Functionality

  • Homepage loads without errors
  • No console errors in browser DevTools
  • All images load correctly
  • Navigation works (all pages accessible)
  • PWA manifest loads
  • Service worker registers

Authentication

  • Sign up page loads
  • Can create new account
  • Email verification works (if enabled)
  • Login page loads
  • Can log in with credentials
  • Can log in with Google (if enabled)
  • Password reset works
  • Logout works
  • Session persists on refresh

Chat Functionality

  • Chat interface loads
  • New chat created automatically on first login
  • Can send messages
  • AI responds to messages
  • Messages display correctly
  • Markdown rendering works
  • Code blocks render with syntax highlighting
  • Auto-scroll works on new messages
  • Can create multiple chats
  • Can switch between chats
  • Chat history persists

AI Features

  • AI responses are coherent
  • Groq provider works (check console logs)
  • Fallback chain works (if Groq fails)
  • Model selection works
  • Different tones work (helpful, formal, casual)
  • Technical levels work (beginner, intermediate, expert)
  • Context is maintained in conversation
  • Memory system works (if enabled)

Voice Features

  • TTS toggle in settings
  • TTS is OFF by default
  • Can enable TTS
  • Groq Orpheus TTS works
  • Voice selection works (troy, diana, hannah, etc.)
  • Fallback to Edge TTS works
  • Fallback to Browser TTS works
  • Can disable TTS
  • STT (speech-to-text) works (if enabled)

Settings & Account

  • Settings dialog opens
  • Can change model
  • Can change tone
  • Can change technical level
  • Can change voice
  • Settings persist on refresh
  • Account page loads
  • Profile tab works
  • Settings tab works
  • Features tab works
  • Security tab works
  • Can update profile
  • Can change password
  • Can delete account

API Routes

  • /api/health returns healthy status
  • /api/chat works
  • /api/tts works
  • /api/transcribe works (if enabled)
  • /api/profile works
  • No 404 errors on API routes
  • No 500 errors on API routes
  • API responses are fast (< 5s)

Performance

  • Page load time < 3 seconds
  • Time to Interactive < 5 seconds
  • First Contentful Paint < 2 seconds
  • Largest Contentful Paint < 4 seconds
  • No layout shifts (CLS < 0.1)
  • Images optimized and lazy-loaded
  • Fonts load quickly

Mobile Responsiveness

  • Works on mobile (< 768px)
  • Works on tablet (768px - 1024px)
  • Works on desktop (> 1024px)
  • Touch interactions work
  • Keyboard works on mobile
  • No horizontal scroll
  • Text is readable
  • Buttons are tappable

PWA Features

  • Can install as PWA
  • App icon shows correctly
  • Splash screen works
  • Works offline (basic functionality)
  • Offline page shows when no connection
  • Service worker updates correctly

SEO & Meta

  • Page titles are correct
  • Meta descriptions present
  • Open Graph tags present
  • Twitter Card tags present
  • Favicon loads
  • robots.txt accessible
  • sitemap.xml accessible
  • Structured data present

Security

  • HTTPS enabled (automatic on Vercel)
  • Security headers present
  • No API keys exposed in client code
  • CORS configured correctly
  • XSS protection enabled
  • Content Security Policy headers
  • No mixed content warnings

Monitoring Setup

Vercel Dashboard

  • Enabled Vercel Analytics
  • Checked deployment logs
  • Verified function logs
  • Set up deployment notifications
  • Configured custom domain (if applicable)

Firebase Console

  • Verified Firestore rules deployed
  • Checked authentication settings
  • Verified authorized domains
  • Reviewed usage quotas
  • Set up billing alerts (if on Blaze plan)

Error Tracking (Optional)

  • Set up Sentry (optional)
  • Set up LogRocket (optional)
  • Configured error notifications

Performance Optimization

Vercel Settings

  • Enabled Speed Insights
  • Configured caching headers
  • Set up edge functions (if needed)
  • Optimized function regions

Next.js Optimizations

  • Image optimization enabled
  • Font optimization enabled
  • Script optimization enabled
  • Compression enabled

User Testing

Test with Friends

  • Shared URL with Vidhan
  • Shared URL with Avineet
  • Shared URL with Vansh
  • Shared URL with Aayush
  • Shared URL with Varun
  • Shared URL with Pankaj
  • Shared URL with Masum
  • Shared URL with Sachin
  • Shared URL with Pardhuman
  • Shared URL with Shivansh
  • Shared URL with Vaibhav
  • Shared URL with Kartik

Collect Feedback

  • Created feedback form
  • Documented issues found
  • Prioritized bug fixes
  • Planned feature improvements

Documentation

Update Documentation

  • Updated README.md with production URL
  • Updated API documentation
  • Created user guide (if needed)
  • Documented known issues
  • Created troubleshooting guide

Share Information

  • Shared deployment URL with team
  • Shared admin credentials (if applicable)
  • Documented environment variables
  • Created runbook for common issues

Post-Launch Tasks

Week 1

  • Monitor error logs daily
  • Check performance metrics
  • Review user feedback
  • Fix critical bugs
  • Optimize slow queries

Week 2

  • Analyze usage patterns
  • Review API costs
  • Optimize expensive operations
  • Plan feature improvements
  • Update documentation

Month 1

  • Review analytics
  • Assess scaling needs
  • Plan infrastructure upgrades
  • Evaluate user satisfaction
  • Plan next features

Rollback Plan

If Issues Occur

  • Identify the problem
  • Check Vercel function logs
  • Review recent changes
  • Rollback to previous deployment (one-click in Vercel)
  • Notify users of downtime
  • Fix issue in development
  • Test thoroughly
  • Redeploy

Success Criteria

Deployment Success

  • ✅ Build completes without errors
  • ✅ All pages load correctly
  • ✅ Authentication works
  • ✅ AI chat works
  • ✅ No critical errors in logs
  • ✅ Performance metrics acceptable
  • ✅ Mobile responsive
  • ✅ PWA installable

User Success

  • ✅ Users can sign up
  • ✅ Users can chat with AI
  • ✅ Users can save conversations
  • ✅ Users can customize settings
  • ✅ Users report positive experience
  • ✅ No major bugs reported

Maintenance Schedule

Daily

  • Check error logs
  • Monitor uptime
  • Review user feedback

Weekly

  • Review analytics
  • Check API usage
  • Update dependencies (if needed)
  • Deploy bug fixes

Monthly

  • Security audit
  • Performance review
  • Cost analysis
  • Feature planning
  • Documentation updates

Emergency Contacts

Vercel Support

Firebase Support

API Providers

Deployment Date: _____________ Deployed By: _____________ Production URL: _____________ Status: ⬜ In Progress | ⬜ Completed | ⬜ Issues

Last Updated: February 28, 2026 Version: 2.0.0