Updated README.md with instructions on how to use docker local + prod environments.

Author: digitalnomad91

README.md

@@ -1,57 +1,89 @@
-# Codebuilder Webapp
+# Codebuilder Frontend
 
 [![Deploy Production Docker Container](https://github.com/codebuilderinc/codebuilder-frontend/actions/workflows/deploy-docker.yml/badge.svg)](https://github.com/codebuilderinc/codebuilder-frontend/actions/workflows/deploy-docker.yml)
 
+Next.js frontend for Codebuilder.
 
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+## Environment Files
 
-## Getting Started
+- `pnpm dev` (Next.js dev server) loads environment variables in this order:
+	- `.env.local` (preferred for local-only overrides)
+	- `.env`
+- Docker Compose loads `.env` because `docker-compose.yml` explicitly uses `env_file: ./.env`.
 
-First, setup your mysql database and edit the .env.example file. 
+Important: inside Docker, Postgres must be reached via `db:5432` (service name + container port), not `localhost`.
 
-```bash 
-cp .env.example .env.local
+## Commands
+
+Run any command as:
+
+```bash
+pnpm <command>
 ```
 
-Run the development server:
+List all available commands:
 
 ```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
+pnpm run
 ```
 
-Build the production Docker container:
+### Core
+
 ```bash
-docker run -d --network host -p 3000:3000 --env-file .env --name codebuilder-webapp codebuilder-webapp:latest
+pnpm dev
+pnpm build
+pnpm build:static
+pnpm start
+pnpm lint
 ```
 
-Note: The production website will automatically build & deploy through a GH action anytime a push is made to main.
+- `dev`: Start Next.js dev server (Turbopack).
+- `build`: Production build.
+- `build:static`: Static export build (only if export mode is supported).
+- `start`: Run production server from `.next` build output.
+- `lint`: Run linting.
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+### Local DB (for development)
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+```bash
+pnpm dev:db:start
+pnpm dev:db:stop
+pnpm dev:db:prepare
+```
+
+- `dev:db:start`: Start the local Postgres container using `docker-compose.local.yml`.
+- `dev:db:stop`: Stop/remove the local Postgres container.
+- `dev:db:prepare`: Create the Prisma shadow database inside Postgres (safe to re-run).
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+### Prisma
 
-## Learn More
+```bash
+pnpm prisma:migrate
+pnpm prisma:generate
+pnpm prisma:studio
+```
 
-To learn more about Next.js, take a look at the following resources:
+- `prisma:migrate`: Run Prisma migrations in development mode.
+- `prisma:generate`: Regenerate Prisma client.
+- `prisma:studio`: Launch Prisma Studio.
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+### Docker (Production / Server)
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+```bash
+pnpm prod:up
+pnpm prod:down
+pnpm prod:logs
+pnpm prod:reset
+```
 
-## Deploy on Vercel
+- `prod:up`: Rebuild and redeploy the Docker Compose stack (frontend + db). This is the main manual deploy command.
+- `prod:down`: Stop/remove the stack containers and networks (does not delete external volumes unless `--volumes` is used).
+- `prod:logs`: Tail logs for the `frontend` service.
+- `prod:reset`: WARNING: brings the stack down with `--volumes` and starts fresh (will wipe DB data).
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## CI / Deployment
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+On push to `main`, the GitHub Actions workflow rebuilds and redeploys the Docker services on the self-hosted runner.
 
 ## Activity
 ![Alt](https://repobeats.axiom.co/api/embed/f01e046c8b7d8a2c653ee751c55c2345072872c4.svg "Repobeats analytics image")