Getting Started¶

This guide walks you through running EERP locally and making your first change.

Prerequisites¶

Install the Rust WASM target once:

rustup target add wasm32-unknown-unknown

Clone and Configure¶

git clone https://github.com/your-org/eerp.git
cd eerp

Copy and adjust the runtime configuration:

cp eerp-config.json.example eerp-config.json

The only fields you typically need to change locally are module_root (absolute path to where your compiled modules live) and master_key (used for signing tokens). See Configuration for a full reference.

Start the Database¶

docker compose up -d

This starts PostgreSQL 18 on localhost:5432 with:

• Database: poc
• User: postgres
• Password: postgres

Run Everything¶

make run

This target starts three processes in sequence:

1. Database (Docker, if not already running)
2. Backend (go run ./cmd/app/...)
3. Frontend (npm run dev on :5173)

Run only the backend¶

make run-back

Run only the frontend¶

make run-front

Build WASM Modules¶

WASM modules are Rust crates compiled to wasm32-unknown-unknown. To build all modules:

make build

The compiled .wasm binaries are placed into the module directories. The module loader auto-discovers them on startup.

Project Startup Sequence¶

When you run the backend, the following happens in order:

sequenceDiagram
    participant Main as main.go
    participant Config as Config Loader
    participant DB as PostgreSQL
    participant ML as Module Loader
    participant WASM as WASM Runtime

    Main->>Config: Read eerp-config.json
    Config-->>Main: Config struct
    Main->>DB: Open connection pool (pgxpool)
    DB-->>Main: *orm.DB
    Main->>ML: LoadModules(config, db)
    ML->>ML: Scan module_root for module.json files
    ML->>ML: Resolve dependency order
    loop Per priority group (concurrent)
        ML->>WASM: Instantiate .wasm binary
        WASM-->>ML: Instance
        ML->>WASM: Call migrate() + migrate_len()
        WASM-->>ML: Migration JSON pointer
        ML->>DB: Apply schema migrations (ALTER TABLE)
    end
    Main->>Main: Start HTTP server

Running Tests¶

Unit tests (no database required)¶

make run-back-tests BACKTESTPATH=./orm/...

Integration tests (requires Docker database)¶

make run-back-tests BACKTESTPATH=./orm/pool/db/...

Single test by name¶

make run-back-tests BACKTESTPATH=./orm/... ARGS="-run TestFindOne"

Next Steps¶

• Read Architecture Overview to understand how the layers relate.
• Read Creating a Module to build your first WASM module.
• Read ORM to understand how to work with the database.