Installation

Getting ErgoPlanner up and running on your system

System Requirements

Minimum Requirements

Component	Requirement
OS	Windows 10/11, macOS 11+, Linux (Ubuntu 20.04+)
RAM	8 GB
Storage	2 GB free space
Display	1280 x 720 resolution
Browser	Chrome 90+, Firefox 88+, Safari 14+, Edge 90+

Recommended Requirements

Component	Requirement
RAM	16 GB
Storage	SSD with 5 GB free
Display	1920 x 1080 resolution
Network	Broadband internet connection

Large drawings need WebGPU. The SVG/DOM renderer is supported for drawings of up to 10,000 elements. Above that, ErgoPlanner relies on the WebGPU renderer, so use a current Chrome or Edge with hardware acceleration enabled for very large drawings.

Installation Methods

Method 1: Web Application (Recommended)

ErgoPlanner runs directly in your browser - no installation required.

1. Navigate to ErgoPlanner Web App
2. Create an account or sign in
3. Start your first project

Method 2: Local Development Setup

For developers who want to run ErgoPlanner locally:

Prerequisites

# Node.js 18+ and npm
node --version  # Should be 18.0.0 or higher
npm --version   # Should be 9.0.0 or higher

# .NET Core 9.0+
dotnet --version  # Should be 9.0.0 or higher

Frontend Setup

# Clone repository
git clone https://github.com/your-org/ergoplanner.git
cd ergoplanner/src/frontend

# Install dependencies
npm install

# Start development server
npm run dev

The frontend will be available at http://localhost:5173

Backend Setup

cd ergoplanner/src/backend

# Restore packages
dotnet restore

# Build and run
dotnet run --project ErgoPlanner.API

The API will be available at http://localhost:5000

First Launch

After installation:

1. Create Account: Sign up with email or OAuth provider
2. Select Plan: Choose free tier or professional plan
3. Complete Setup: Follow the onboarding wizard
4. Create Project: Start your first wastewater treatment project

Configuration

Environment Variables

For local development, configure these environment variables:

Variable	Description	Default
VITE_API_URL	Backend API endpoint	http://localhost:5000
VITE_AUTH_PROVIDER	Authentication provider	local

User Settings

Customize ErgoPlanner in Settings:

• Theme: Light, Dark, or System preference
• Units: Metric (SI) or Imperial
• Language: English (more coming soon)
• Autosave: Enable/disable automatic saving

Troubleshooting Installation

Common Issues

Issue	Solution
Page won't load	Check browser compatibility, clear cache
Login failed	Verify email, check network connection
Slow performance	Close other browser tabs, check RAM usage
API connection failed	Verify backend is running, check CORS settings

Browser-Specific Issues

Chrome: Ensure hardware acceleration is enabled in Settings > System

Firefox: Disable Enhanced Tracking Protection for ErgoPlanner domain

Safari: Enable "Allow all cookies" for sessions to persist

Next Steps

After successful installation:

1. Quick Start Guide - Create your first simulation
2. Interface Overview - Learn the UI
3. Keyboard Shortcuts - Work faster

Getting Help

• FAQ - Frequently asked questions
• Common Issues - Troubleshooting guide
• GitHub Issues - Report problems