Deployment Guide

Learn how to deploy your AI agent projects and showcase them

1

Push to GitHub

Create a new repository on GitHub and push your project code.

git init
git add .
git commit -m "Initial commit"
git branch -M main
git remote add origin https://github.com/yourusername/your-repo.git
git push -u origin main
Make sure to add a .gitignore file to exclude sensitive files
2

Add .env Safely

Never commit your .env file to GitHub. Instead, use environment variables in your hosting platform.

# .gitignore
.env
.env.local
__pycache__/
*.pyc
Create a .env.example file with placeholder values
Add your actual API keys in your hosting platform's environment variables section
3

Deploy on Netlify or Vercel

Option A: Netlify

  1. Go to netlify.com and sign in
  2. Click "Add new site" → "Import an existing project"
  3. Connect your GitHub repository
  4. Configure build settings:
    Build command: npm run build
    Publish directory: .next
  5. Add environment variables in Site settings → Environment variables
  6. Deploy!

Option B: Vercel

  1. Go to vercel.com and sign in
  2. Click "Add New Project"
  3. Import your GitHub repository
  4. Vercel auto-detects Next.js settings
  5. Add environment variables in Project settings
  6. Deploy!
4

Add Disclaimer & Security

Add important disclaimers and security measures to your project.

README.md Checklist

  • Project description and purpose
  • Installation instructions
  • Environment variables setup
  • Usage examples
  • Limitations and disclaimers
  • License information

Security Best Practices

  • Never expose API keys in client-side code
  • Use rate limiting for API calls
  • Add input validation and sanitization
  • Include error handling
  • Add logging for debugging
5

Make Portfolio Screenshot

Capture screenshots of your deployed project for your portfolio.

Take screenshots of key features and UI
Create a demo video or GIF (optional but recommended)
Add project to your portfolio website

Next Steps

View Showcase
See what others have built
Continue Learning
Explore more modules