Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 2.56 KB

README.md

File metadata and controls

90 lines (56 loc) · 2.56 KB

Vercel to Discord Notifications

A professional integration service that forwards Vercel deployment events to Discord channels through webhooks. Monitor your deployment status efficiently within your team's Discord workspace.

Deployment Notification Example

Features

  • Real-time deployment notifications
  • Seamless integration with Vercel and Discord
  • Minimal setup required
  • Lightweight Next.js implementation

Setup Guide

Prerequisites

  • A Vercel account with deployment access
  • Discord server with administrative privileges
  • Node.js and npm (for local development)

Configuration Steps

  1. Vercel Webhook Configuration

    • Navigate to your Vercel settings
    • Configure the webhook endpoint: https://<your-domain>/api/vercel-webhook
    • Save the generated webhook secret

    Vercel Webhook Configuration

  2. Discord Webhook Setup

    • Access your Discord server settings
    • Create a new webhook in the desired channel
    • Copy the webhook URL

    Discord Webhook Setup

  3. Environment Configuration

    # Vercel webhook secret (obtained from webhook setup)
    WEBHOOK_INTEGRATION_SECRET=your_webhook_secret
    
    # Discord webhook URL
    DISCORD_WEBHOOK_URL=your_discord_webhook_url

Deployment Options

Vercel Deployment (Recommended)

The fastest way to deploy this service is through Vercel's platform:

Deploy with Vercel

Self-Hosted Deployment

For self-hosted environments, we recommend using container orchestration platforms:

  • Dokploy - Simplified container deployment
  • Coolify - Self-hosted PaaS solution

Development

Local Setup

  1. Clone the repository
  2. Install dependencies: pnpm install
  3. Configure environment variables
  4. Start development server: pnpm run dev

Contributing

Contributions are welcome. Please follow these steps:

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push to the branch
  5. Open a Pull Request

Credits

Original concept by @rewbs. This implementation represents a complete architectural redesign and rewrite.

License

This project is open-source and available under the MIT License. See LICENSE for details.