Setup & Deployment - Webyes Auditor

Prerequisites

Requirement	Version
Node.js	20+
npm	10+
Redis	7+ (local or remote)
Docker	24+ (for container deployment)

Local Development

Clone and install

cd /path/to/auditor-report
npm install

Configure environment

cp .env.sample .env
# Edit .env with your credentials (see Environment Variables below)

Start Redis

# Docker (quick)
docker run -d -p 6379:6379 redis:7-alpine

# Or use your local Redis installation
redis-server

Run dev servers

# Both frontend + backend (hot reload)
npm run dev

# Backend only
npm run dev:backend

# Frontend PDF viewer only
npm run dev:frontend

The backend starts on http://localhost:8001 by default. The frontend Vite dev server starts on http://localhost:5173.

Environment Variables

All variables are required unless marked optional.

Core

Redis

Email (Resend)

AWS

Stripe

Slack

CDN

Build

# Build backend only (outputs to dist-server/)
npm run build:backend

# Build frontend only (outputs to dist/)
npm run build:frontend

# Build both
npm run build:frontend && npm run build:backend

Docker

Local container

docker-compose up --build

The docker-compose.yml reads from .env and maps port ${PORT} (default 8001).

Production deployment (AWS ECR)

The deploy.sh script builds for linux/arm64 and pushes to ECR:

# Deploy to staging
./deploy.sh staging

# Deploy to production
./deploy.sh prod

What deploy.sh does:

Authenticates Docker to ECR (aws ecr get-login-password)
Builds the image with --platform linux/arm64
Tags as {ECR_REGISTRY}/auditor-report:{env}
Pushes to ECR

ECR registry: 471112865883.dkr.ecr.eu-west-1.amazonaws.com Requires AWS CLI configured with ECR push permissions.

npm Scripts Reference

Script	Purpose
`npm run dev`	Start frontend + backend concurrently (hot reload)
`npm run dev:frontend`	Vite frontend dev server only
`npm run dev:backend`	tsx watch backend only
`npm run build:frontend`	Production Vite build → `dist/`
`npm run build:backend`	tsc compile backend → `dist-server/`
`npm run start:backend`	Start compiled server (production)
`npm run lint`	ESLint check
`npm run preview`	Preview production frontend build

​Prerequisites

​Local Development

​Environment Variables

​Core

​Redis

​Email (Resend)

​AWS

​Stripe

​Slack

​CDN

​Build

​Docker

​Local container

​Production deployment (AWS ECR)

​npm Scripts Reference

Prerequisites

Local Development

Environment Variables

Core

Redis

Email (Resend)

AWS

Stripe

Slack

CDN

Build

Docker

Local container

Production deployment (AWS ECR)

npm Scripts Reference