Skip to main content

Quick Start

Get the SIMPLE web platform up and running in under 10 minutes.

What You Need First​

Before starting, ensure you have:

  • Node.js v24 or later installed
  • GAMA platform (for running virtual universes)
  • Meta Quest headset (optional, for VR functionality)
  • A code editor (VS Code recommended)

Step-by-Step Setup​

1. Install Dependencies​

Download and install the following:

  1. Node.js - Download from nodejs.org
  2. GAMA - Download from gama-platform.org
  3. ADB (optional) - Required for headset connectivity

2. Get the Web Platform​

# Clone or download from GitHub
git clone https://github.com/project-SIMPLE/simple.webplatform
cd simple.webplatform

3. Configure Environment (Optional)​

# Copy the example environment file
cp .env.example .env

Edit .env and set at minimum:

  • LEARNING_PACKAGE_PATH="./learning-packages"
  • Your GAMA connection settings (if using GAMA)

See the .env reference for all options.

4. Install and Run​

# Install dependencies (only first time)
npm install

# Start the application
npm start

5. Open in Browser​

Navigate to http://localhost:8000

Next Steps​

Troubleshooting​

  • Application won't start? Check that port 8000 is available
  • Can't connect to GAMA? Verify GAMA is running and GAMA_WS_PORT matches
  • Headset issues? See the troubleshooting guide