Skip to content

DEPLOYMENT_SUMMARY.md

Latest commit

 

History

History
223 lines (172 loc) · 5.21 KB

DEPLOYMENT_SUMMARY.md

File metadata and controls

223 lines (172 loc) · 5.21 KB
Raw

Uplink Deployment Summary

📋 What You Have

A production-ready, fully-branded FOSS URL Shortener with:

  • ✅ BroCode branding throughout
  • ✅ Community ecosystem links (Shareb.in, Vericert, Event Horizon)
  • ✅ Open source on GitHub
  • ✅ 3 custom domains configured
  • ✅ Production build passing
  • ✅ All documentation ready

🚀 3-Step Deployment to Vercel

Step 1: Add Repository to Vercel (5 min)

1. Go to https://vercel.com
2. Click "Add New" → "Project"
3. Select GitHub repo: BroCode501/uplink
4. Click "Import"

Step 2: Set Environment Variables (5 min)

In Vercel Settings → Environment Variables, add:

NEXT_PUBLIC_SUPABASE_URL=https://nmpnefwcziwjkibquvey.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=sb_publishable_KMMYBgDp_71D7zcykdoHlg_c0PERWt5
NEXT_PUBLIC_SHORT_URL_BASE=https://meetra.live

✅ Set scope: Production, Preview, Development

Step 3: Configure Domains (10 min)

In Vercel Settings → Domains, add:

  • meetra.live
  • uplink.neopanda.tech
  • uplink-brocode.vercel.app (auto)

Point DNS records to Vercel nameservers.

🔍 Environment Variables Overview

Variable Value Where
NEXT_PUBLIC_SUPABASE_URL https://nmpnefwcziwjkibquvey.supabase.co Supabase Settings
NEXT_PUBLIC_SUPABASE_ANON_KEY sb_publishable_KMMYBgDp_... Supabase Settings
NEXT_PUBLIC_SHORT_URL_BASE https://meetra.live Your choice

⚠️ Important:

  • All 3 are PUBLIC (safe in frontend code)
  • Must be HTTPS
  • No trailing slashes
  • Supabase vars stay same, SHORT_URL_BASE can vary by domain

📊 Your 3 Domains

Domain Usage
meetra.live 🎯 Primary production domain
uplink.neopanda.tech Alternative/secondary domain
uplink-brocode.vercel.app Default Vercel domain (testing)

How it works:

  • All 3 point to the same Vercel deployment
  • Same Supabase database
  • Short links work across all domains
  • Users can use any domain to access

✅ Pre-Deployment Checklist

Before Deploying:

  • GitHub repo ready: BroCode501/uplink
  • Supabase project created
  • Database schema NOT yet run (run in Supabase after deploy)
  • Vercel account created
  • 3 domains registered/controlled

During Deployment:

  • Connect GitHub to Vercel
  • Add 3 environment variables
  • Configure 3 domains
  • Trigger deploy

After Deployment:

  • Wait for build to complete
  • Run SQL schema in Supabase
  • Test signup/login on all domains
  • Test create link
  • Test link redirect
  • Test dashboard

🔧 What Happens After Deploy

1. Supabase Setup (Required)

1. Open Supabase dashboard
2. Go to SQL Editor
3. Create new query
4. Copy entire sql-schema.sql file contents
5. Paste and execute
6. Verify tables created: short_urls, url_clicks

2. Test the App

✅ Visit: https://meetra.live
✅ Click "Sign up"
✅ Create test account
✅ Create a short link
✅ Click on short link - should redirect
✅ Check dashboard - see statistics
✅ Repeat on other 2 domains

3. Monitor

✅ Check Vercel Analytics
✅ Monitor Supabase for usage
✅ Set up alerts for errors

📁 Key Files & Docs

File Purpose
ENV_QUICK_REFERENCE.md Quick env var lookup
VERCEL_DEPLOYMENT.md Detailed deployment guide
sql-schema.sql Database schema (run in Supabase)
README.md Project overview
IMPLEMENTATION_SUMMARY.md Technical architecture

🎯 Your Setup

Repository: https://github.com/BroCode501/uplink
Domains:

  • Production: meetra.live
  • Staging: uplink.neopanda.tech
  • Testing: uplink-brocode.vercel.app

Database:

  • Supabase Project ID: nmpnefwcziwjkibquvey
  • Tables: short_urls, url_clicks

Branding:

  • Primary color: Amber (BroCode)
  • Community: Shareb.in, Vericert, Event Horizon
  • FOSS: Open source on GitHub

🚨 If Deployment Fails

Build Fails:

Check: Dependencies, TypeScript errors
Run locally: npm run build
Fix errors, push to GitHub, redeploy

Links Don't Redirect:

Check: NEXT_PUBLIC_SHORT_URL_BASE matches your domain
Should be: https://meetra.live (no trailing slash)
Redeploy after fix

Supabase Connection Error:

Check: NEXT_PUBLIC_SUPABASE_URL and ANON_KEY are correct
Check: Supabase project is active
Verify: No trailing slashes
Redeploy

Database Tables Missing:

Run SQL schema in Supabase SQL Editor
Must be done after deployment
Verify 2 tables created: short_urls, url_clicks

📞 Need Help?

Quick Reference: ENV_QUICK_REFERENCE.md
Detailed Guide: VERCEL_DEPLOYMENT.md
Code Issues: GitHub Issues
Supabase: https://supabase.com/docs
Vercel: https://vercel.com/docs
Next.js: https://nextjs.org/docs

🎉 What Comes Next

✅ Production live on meetra.live
✅ Users can shorten links across 3 domains
✅ Analytics tracking click statistics
✅ Community ecosystem visible in footer
✅ Open source on GitHub for contributions
✅ FOSS badge showing community support

You're all set for deployment! 🚀

Start with Step 1 above, or refer to detailed guides in this repo.