From d63753b8bd13296c4ae923fc44770753caf71b34 Mon Sep 17 00:00:00 2001 From: Andreas Opferkuch Date: Thu, 7 Nov 2024 18:52:04 +0100 Subject: [PATCH] Improve deployment instructions --- .github/workflows/deploy.yml | 2 +- README.md | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 7878991..7f28e4c 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -18,7 +18,7 @@ jobs: - name: Use Node.js 20 uses: actions/setup-node@v4 with: - node-version: 20 + node-version: 22 - name: Install, test, deploy run: | pnpm install --frozen-lockfile diff --git a/README.md b/README.md index 166b6c8..5f12c34 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,11 @@ I'm using relatively few dependencies that front-end engineers are likely famili - A GitHub OAuth app (provides ID and SECRET values for `.env`) - ChatGPT API key -## Getting started (vercel/docker) +## Getting started -- Add secrets either on vercel or in your docker environment based on `.env.schema` -- Deploy 🚀 +- Add secrets to whatever environment you will run this in based on `.env.schema`. +- (At least with the combination of CapRover and cloudflare for HTTPS, it is necessary to tick "WebSocket support" in the app settings in CapRover for streaming to work. I don't know why, since that is done via fetch, not websockets but that's what I've observed.) +- Deploy like any node app. 🚀 (See `Dockerfile`, `deploy.sh` and the github workflow for inspiration if you're not using a platform that automatically does these things for you.) ## Getting started (dev)