From ef21fef477448a47222b4905ea84afd15f11e80f Mon Sep 17 00:00:00 2001 From: Riccardo Date: Mon, 8 Jul 2024 12:16:05 +0200 Subject: [PATCH] docs: updated documentation and scripts --- README.md | 38 ++++++++++++++++++++++++-------------- docker-compose.yml | 4 ++-- package.json | 3 --- 3 files changed, 26 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index d0ae635..962d1ae 100644 --- a/README.md +++ b/README.md @@ -2,28 +2,22 @@ ## Commands -Install vercel cli +Install dependencies ```bash -yarn add -g vercel@latest +yarn ``` -Link to vercel +Run Postgres on Docker ```bash -yarn vercel:link +docker-compose up ``` -Pull env variables from vercel +Run Prisma migrations ```bash -yarn vercel:env -``` - -Push Prisma schema to vercel - -```bash -yarn db:push +yarn prisma:migrate ``` Generate Prisma client @@ -38,8 +32,24 @@ Reset Prisma database yarn db:reset ``` -Run on Docker +## Auth0 Webhook + +Auth0 Flow to register new users ```bash -docker-compose up --build +const axios = require('axios'); + +exports.onExecutePostUserRegistration = async (event) => { + await axios.post(event.secrets.WEBHOOK_URL, { email: event.user.email }, { + headers: { + 'Authorization': `Bearer ${event.secrets.AUTH0_API_SECRET_KEY}`, + 'Content-Type': 'application/json' + } + }); +}; ``` + +Add the following secrets to your Flow: + +- `WEBHOOK_URL`: The URL of your webhook. +- `AUTH0_API_SECRET_KEY`: The Auth0 API secret key. diff --git a/docker-compose.yml b/docker-compose.yml index bc23fcf..fd05ebd 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -7,9 +7,9 @@ services: POSTGRES_PASSWORD: postgres POSTGRES_DB: postgres ports: - - "5432:5432" + - '5432:5432' volumes: - postgres-data:/var/lib/postgresql/data volumes: - postgres-data: + postgres-data: diff --git a/package.json b/package.json index 6e96566..dfc49d5 100644 --- a/package.json +++ b/package.json @@ -10,10 +10,7 @@ "format": "prettier --config .prettierrc 'app/' --write", "typecheck": "tsc --noEmit", "prepare": "husky install", - "vercel:link": "vercel link", - "vercel:env": "vercel env pull .env", "prisma:migrate": "npx prisma migrate dev", - "prisma:push": "npx prisma db push", "prisma:generate": "npx prisma generate", "prisma:reset": "npx prisma db push --force-reset" },