From 761c46a1305e63f1898676e78adf62e946ed0685 Mon Sep 17 00:00:00 2001 From: Mat Morris Date: Sun, 5 Jan 2025 23:26:41 -0600 Subject: [PATCH] Chore/add dev env scripts for rebuiling frontend easily (#43) * adds dev docker scripts * refine commands and add to readme --- README.md | 16 ++++++++++++++-- package.json | 3 +++ 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ab3b1d0..1e71d12 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,21 @@ npx vercel env pull ``` -- run `docker compose up -d` +- run application using docker + ```bash + npm run dev:docker + ``` + +The frontend next application will be ready for connections at `localhost:3000`. +The postgres database will be ready for connections at `localhost:5432`. + +## Some important scripts -The app should be exposed at `localhost:3000` ready for development. +|command|description| +|-|-| +|`npm run rebuild-frontend`|Will rebuild the next application and start it up without triggering a database rebuild| +|`npm run dev:docker`|starts dev environment via docker| +|`npm run dev:logs`|starts reading docker compose log files for application container| ## What happens when I push a new branch to Github? 1. Vercel [creates a Preview deployment](https://vercel.com/magicians/magic-vault/deployments) diff --git a/package.json b/package.json index 944fedf..3cc5649 100644 --- a/package.json +++ b/package.json @@ -6,6 +6,9 @@ "build": "next build", "postinstall": "prisma generate", "dev": "next dev", + "dev:docker": "docker compose up -d", + "dev:logs": "docker compose logs -f", + "rebuild-frontend": "docker compose up -d --build next-app", "lint": "next lint", "start": "next start", "test": "SKIP_ENV_VALIDATION=true jest",