Skip to content

QUICK_START.md

Latest commit

 

History

History
105 lines (77 loc) · 3.16 KB

QUICK_START.md

File metadata and controls

105 lines (77 loc) · 3.16 KB

🚀 Quick Start - Samvaad is Running!

✅ Server Status

Your development server is now running at: http://localhost:3000

📋 Next Steps - Environment Setup

1. Set Up Supabase (Required for Authentication & Database)

  1. Go to https://supabase.com and create a free account

  2. Create a new project

  3. Wait 2-3 minutes for the database to initialize

  4. Go to Settings → API and copy:

    • Project URL (looks like: https://xxxxx.supabase.co)
    • anon/public key (starts with eyJ...)

  5. Create .env.local file in the project root:

    cp .env.example .env.local

  6. Edit .env.local and add your Supabase credentials:

    NEXT_PUBLIC_SUPABASE_URL=https://your-project.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_anon_key_here

  7. Run the database migration:

    • Go to Supabase Dashboard → SQL Editor
    • Copy the contents of supabase/migrations/20250313212230_init.sql
    • Paste and run it

  8. Restart the dev server (Ctrl+C, then pnpm dev)

2. Set Up Azure OpenAI (Required for AI Chat Features)

  1. Go to Azure Portal
  2. Create an Azure OpenAI resource
  3. Deploy a model (gpt-4 or gpt-35-turbo)
  4. Copy the endpoint and API key
  5. Add to .env.local: 
    AZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com
AZURE_OPENAI_API_KEY=your_key_here
AZURE_OPENAI_DEPLOYMENT=gpt-4

3. Optional Azure Services (Enhanced Features)

For enhanced features, also add:

  • Azure Speech Services (for advanced TTS/STT)
  • Azure Translator (for multilingual support)
  • Azure Cognitive Services (for sentiment analysis)

See SETUP_GUIDE.md for detailed instructions.

🎯 What's Working Now

✅ Frontend UI - All pages are accessible ✅ Navigation - Routing and navigation working ✅ Styling - Tailwind CSS and components ✅ Middleware - Supabase session management (once env vars are set)

⚠️ What Needs Configuration

  • 🔴 Supabase - Required for login/database
  • 🔴 Azure OpenAI - Required for AI chat features
  • 🟡 Azure Speech - Optional, for enhanced voice features
  • 🟡 Azure Translator - Optional, for multilingual support

🧪 Testing Without Full Setup

Even without Azure OpenAI, you can:

  • ✅ View the landing page
  • ✅ See the UI/UX
  • ✅ Navigate between pages
  • ⚠️ Login will fail (needs Supabase)
  • ⚠️ Chat will use fallback responses (needs Azure OpenAI)

📚 Documentation

  • Complete Setup: See SETUP_GUIDE.md
  • Project Overview: See README.md
  • Imagine Cup Info: See IMAGINE_CUP.md

🆘 Troubleshooting

Server won't start?

  • Check if port 3000 is available
  • Run pnpm install to ensure dependencies are installed

Environment variables not working?

  • Make sure .env.local is in the project root
  • Restart the dev server after adding env vars
  • Check for typos in variable names

Supabase connection errors?

  • Verify your URL and key are correct
  • Make sure the database migration has been run
  • Check Supabase project is active

Current Status: Server running, ready for environment configuration! 🎉