Prerequisites

• Docker Desktop installed and running
• pnpm 8.9.0+ (included via corepack in Docker)
• MongoDB Compass Application

Quick Installation Workflow:

• Install Docker Desktop, make an account, and run
• Install MongoDB Compass, make an account, and add cluster connection string (from .env file)
• Clone Repository locally
• Run in terminal:
• pnpm install
• pnpm dev:build
• pnpm dev
• pnpm logs (to perform logging of application while running)
• Open the application frontend at http://localhost:5173
• Create an account/log in

Setup

Install dependencies (optional for local development):

   pnpm install

Development

Start all services in development mode with hot-reload:

pnpm dev

Services and Ports:

• Frontend: http://localhost:5173
• API: http://localhost:4000
• Redis: localhost:6379

View logs:

pnpm logs              # All services
pnpm logs:api          # API only
pnpm logs:frontend     # Frontend only

Production

Test the production build locally:

pnpm prod:build

Check health:

pnpm health

Useful Commands

pnpm down              # Stop all services
pnpm clean             # Remove containers, volumes, and cleanup
pnpm redis:cli         # Access Redis CLI
pnpm shell:api         # Shell into API container
pnpm shell:frontend    # Shell into frontend container

Code Quality

pnpm lint              # Check for linting errors
pnpm format            # Format code and fix linting issues

Project Structure

seitz/
├── packages/
│   ├── api/           # Express backend
│   ├── ui/            # Vue.js frontend
│   └── shared/        # Shared types/utilities
├── docker-compose.yml            # Production configuration
├── docker-compose.dev.yml        # Development configuration
└── package.json                  # Root package scripts

Troubleshooting

Containers won't start:

pnpm clean
pnpm dev:build

Port conflicts: Make sure ports 4000, 5173, and 6379 are not in use by other applications.

Environment variables not loading: Ensure .env file exists in the root directory with all required variables.