Skip to content

deployment.md

Latest commit

 

History

History
59 lines (44 loc) · 1.24 KB

deployment.md

File metadata and controls

59 lines (44 loc) · 1.24 KB
Raw

🚀 Deployment Guide

Prerequisites

  • Ruby 3.3+
  • GitHub App with "Read repository data" permissions

Installation

  1. Clone the repository

    git clone <repository-url>
cd github_project_fetch

  2. Install dependencies

    bundle install

  3. Set up environment variables

    cp .env.example .env
# Edit .env with your GitHub App credentials

  4. Run tests

    bundle exec rspec

Preview Vercel Deployment

  1. Install Vercel CLI

    npm i -g vercel

  2. Deploy

    vercel

  3. Set environment variables in Vercel dashboard

    • Add all variables from your .env file

  4. Update GitHub App URLs

    • Update your GitHub App's webhook and callback URLs to point to your Vercel deployment

  5. Configure Deployment Settings

    • Configure your project in the Vercel dashboard as needed
    • ⚠️ Note: Deployments are managed by Vercel. GitHub Actions runs linting and tests only.

Edge Caching

The API is optimized with response caching using stale-while-revalidate:

  • API Documentation: 1 hour cache, 2 hours stale
  • Health Checks: 10 seconds cache, 1 minute stale
  • Project Data: 10 minutes cache, 20 minutes stale