local-serverless-stack 0.8.0 → 0.10.0

package/README.md

@@ -4,18 +4,29 @@
 
 **Local control plane for serverless development — with its own in-process AWS engine (no Docker) or LocalStack orchestration**
 
-LSS provides a unified local development environment for serverless microservices: one orchestrator provisions and serves every AWS resource your services declare, eliminating the need to run separate LocalStack instances (or, with the **self engine**, any LocalStack at all).
+LSS provides a unified local development environment for serverless microservices: one orchestrator provisions and serves every AWS resource your services declare, eliminating the need to run separate LocalStack instances (or, with the **self engine**, any LocalStack at all). It scales to monorepos with 15+ microservices sharing one stack.
+
+```mermaid
+flowchart LR
+    DEV[Developer] -->|npx lss start| CLI[CLI<br/>bin/cli.js]
+    CLI --> ORCH[Orchestrator<br/>Express API + dashboard :3100]
+    SVC[Your services<br/>serverless.yml + serverless-lss] -->|sls package → register| ORCH
+    ORCH -->|provision + events| ENGINE{Engine}
+    ENGINE -->|"engine: self"| SELF[Self engine<br/>in-process :14566]
+    ENGINE -->|"engine: localstack"| LS[LocalStack<br/>Docker :4566]
+    ORCH --> RT[Lambda runtime + API Gateway emulation<br/>your handlers, ports 30xx/130xx]
+```
 
 ## Features
 
-- **⚡ Self engine (the LSS differentiator)**: DynamoDB, SQS, S3, EventBridge, SNS and the Lambda control plane emulated **in-process** by the orchestrator — no Docker, no LocalStack, no auth token. Boots in milliseconds, stores data in local files, delivers events straight into your handlers. See [Self engine](#self-engine--no-docker-no-localstack-no-auth-token) below.
+- **⚡ Self engine (the LSS differentiator)**: DynamoDB, SQS, S3, EventBridge, OpenSearch Serverless, SNS and the Lambda control plane emulated **in-process** by the orchestrator — no Docker, no LocalStack, no auth token. Boots in milliseconds, stores data in local files, delivers events straight into your handlers. See [Self engine](#self-engine--no-docker-no-localstack-no-auth-token) below.
 - **Centralized provisioning**: Parses CloudFormation templates from `sls package` and provisions resources automatically — into the self engine or a single shared LocalStack, your choice per instance
 - **Event source mappings**: Automatically connects SQS queues, streams, S3 notifications and EventBridge rules to Lambda handlers
 - **Lambda runtime & API emulation**: LSS answers on the same API (30xx) and Lambda invoke (130xx) ports that serverless-offline used
-- **Web UI**: Vue 3 dashboard to monitor services, resources, and event mappings
+- **Web UI**: Vue 3 dashboard to monitor services, resources, and event mappings — [brandable with your company's colors and logo](docs/CONFIGURATION.md#configuration-properties)
 - **Hot reload**: Watch for code changes and auto-rebuild/reprovision
-- **Process management**: Start/stop microservices from the orchestrator
-- **CLI Tool**: Simple commands to manage the orchestrator (start/stop/status/logs)
+- **DynamoDB seeds**: fixtures auto-applied on table creation, re-applied via `lss seed` or the dashboard
+- **CLI + programmatic client**: manage the orchestrator from the shell (`npx lss …`) or from code (`LssClient`)
 
 See [docs/FEATURES.md](docs/FEATURES.md) for the complete feature inventory and how each capability is tested.
 
@@ -43,6 +54,12 @@ What you get:
 - **SQS** with FIFO, visibility redelivery and live counters; **S3** with byte-exact
   object round trips and notifications; **EventBridge** with buses, pattern-filtered
   rules and `rate()`/cron schedules; minimal **SNS** and **STS**.
+- **OpenSearch Serverless**: collections declared as
+  `AWS::OpenSearchServerless::Collection` are provisioned via the real `aoss`
+  control plane and served through the OpenSearch REST API — document CRUD,
+  `_bulk`, `_search` with the everyday query DSL (match/term/range/bool…),
+  sorting and `terms`/metric aggregations — at
+  `http://localhost:14566/_aoss/<collection>`.
 - **Events delivered in-process**: SQS batches, DynamoDB streams, S3 notifications and
   EventBridge targets go straight from the engine to the LSS Lambda runtime — no proxy
   Lambdas, no polling containers.
@@ -51,16 +68,17 @@ What you get:
 flowchart LR
     APP[Your services<br/>AWS SDK → :14566] --> ENG
     subgraph ORCH["One orchestrator process — no Docker"]
-        ENG[Self engine<br/>DynamoDB · SQS · S3<br/>EventBridge · SNS · STS]
+        ENG[Self engine<br/>DynamoDB · SQS · S3 · EventBridge<br/>OpenSearch · SNS · STS]
         ENG -->|in-process events| RT[LSS Lambda runtime<br/>your handlers, ports 30xx/130xx]
         ENG --- FS[(local files<br/>~/.lss/engine)]
     end
 ```
 
-Measured on [examples/self-engine-sample](examples/self-engine-sample/) (3 microservices:
-orders → billing → notifications): engine boot **~10 ms**; a full pipeline crossing
-DynamoDB + SQS + S3 + EventBridge across the three services completes in **~170 ms** —
-with the whole stack being the orchestrator process plus one small worker per service.
+Measured on [examples/self-hosted](examples/self-hosted/) (orders → billing →
+notifications pipeline; the example also carries an OpenSearch catalog service):
+engine boot **~10 ms**; a full pipeline crossing DynamoDB + SQS + S3 + EventBridge
+across the three pipeline services completes in **~170 ms** — with the whole stack
+being the orchestrator process plus one small worker per service.
 
 Migration is gradual: LocalStack mode remains the default and fully supported; a running
 instance picks one engine. Anything the self engine doesn't implement yet answers with an
@@ -68,714 +86,286 @@ explicit error naming the operation — or is forwarded verbatim to a LocalStack
 `selfEngine.fallbackEndpoint`. Coverage matrix and storage model:
 [docs/SELF_ENGINE.md](docs/SELF_ENGINE.md) · design/PRD:
 [docs/PRD_SELF_ENGINE.md](docs/PRD_SELF_ENGINE.md) · runnable demo:
-[examples/self-engine-sample](examples/self-engine-sample/).
-
-## Architecture
-
-```
-local-serverless-stack/
-├── bin/                      # CLI executable
-│   └── cli.js               # lss command entry point
-├── src/                      # Source code
-│   ├── server/              # Express API + services
-│   │   ├── routes/          # API endpoints
-│   │   ├── services/        # Business logic
-│   │   └── dev/             # Dev utilities
-│   └── ui/                  # Vue 3 dashboard
-├── packages/
-│   └── serverless-plugin/   # Serverless Framework plugin (published separately)
-├── dist/                     # Build output
-│   ├── server/              # Compiled Express app
-│   └── ui/                  # Built Vue app
-└── tests/                    # Integration tests
-```
-
-**Components**:
-- **CLI** (`bin/cli.js`): Background process management (start/stop/status/logs)
-- **Server** (`src/server/`): Express API + engine orchestration
-- **Engine** (`src/server/engine/`): the AWS provider behind everything — either the in-process **self engine** (port 14566, no Docker) or a managed/external **LocalStack** container (port 4566)
-- **UI** (`src/ui/`): Vue 3 dashboard for monitoring
-- **Plugin** (`packages/serverless-plugin/`): Auto-registration for Serverless Framework
+[examples/self-hosted](examples/self-hosted/).
 
 ## Quick Start
 
-### Prerequisites
-
-- Node.js >= 20
-- Serverless Framework 3.40.0
-- Docker — **only for the LocalStack engine**; the self engine (`--self-engine`) needs none
-
-### Installation
+Prerequisites: Node.js >= 20 · [osls](https://github.com/oss-serverless/serverless) 4.x (open-source Serverless Framework fork; provides the `serverless`/`sls` CLI) · Docker (**only** for the LocalStack engine)
 
 ```bash
+# 1. Install
 npm install -g local-serverless-stack
-```
-
-Or install locally:
-
-```bash
-cd /path/to/local-serverless-stack
-npm install
-npm run build
-npm link
-```
-
-The `npm link` command makes the `lss` CLI available globally via `npx`.
 
-### Serverless Framework Plugin
+# 2. Start the orchestrator (self engine: no Docker needed)
+npx lss start --self-engine        # or plain `npx lss start` for LocalStack
 
-To automatically register your microservices with LSS, install the Serverless plugin:
-
-```bash
+# 3. In each microservice: install the plugin and add it to serverless.yml
 npm install --save-dev serverless-lss
 ```
 
-See the [plugin documentation](packages/serverless-plugin/README.md) for configuration details.
-
-## CLI Commands
-
-LSS provides a simple CLI to manage the orchestrator in background mode:
-
-```bash
-# Start the orchestrator in background (managed LocalStack)
-npx lss start
-
-# Start with the in-process self engine instead — no Docker
-npx lss start --self-engine
-
-# Check if orchestrator is running
-npx lss status
-
-# View recent logs
-npx lss logs
-
-# Stop the orchestrator
-npx lss stop
-
-# Show help
-npx lss help
-```
-
-### CLI Output
-
-```bash
-$ npx lss start --self-engine
-🚀 LSS Orchestrator started (PID: 12345)
-📊 Server: http://localhost:3100
-🔧 Self Engine: http://localhost:14566 (no Docker)
-✅ Service is running
-
-$ npx lss start
-🚀 LSS Orchestrator started (PID: 12345)
-📊 Dashboard: http://localhost:3100
-🔧 LocalStack: http://localhost:4566
-📝 Logs: /tmp/lss-orchestrator.log
-✅ Service is running
-
-$ npx lss status
-🟢 LSS Orchestrator: RUNNING (PID: 12345)
-📊 Dashboard: http://localhost:3100
-🔧 LocalStack: http://localhost:4566
-📝 Logs: /tmp/lss-orchestrator.log
-```
-
-## Development Mode
-
-For active development with hot reload:
-
-```bash
-npm run orchestrator:dev
-```
-
-This starts:
-- Orchestrator API on http://localhost:3100
-- LocalStack on http://localhost:4566
-- Web UI at http://localhost:3100
-- Auto-reload on code changes
-
-## Integration with Projects
-
-### 1. Link LSS to Your Project
-
-In your project root:
-
-```bash
-npm link local-serverless-stack
-```
-
-### 2. Install Plugin in Microservices
-
-In each microservice directory:
-
-```bash
-npm link serverless-lss
-```
-
-### 3. Configure serverless.yml
-
-Add the plugin to your `serverless.yml`:
-
 ```yaml
+# serverless.yml
 plugins:
-  - serverless-auto-swagger
-  - serverless-esbuild
-  - serverless-offline
-  - serverless-localstack
-  - serverless-lss  # Add this line
+  - serverless-lss
 
 custom:
   orchestrator:
-    url: http://localhost:3100  # optional, defaults to this
+    enabled: true
+    orchestratorUrl: http://localhost:3100   # must match serverPort
+  lss:
+    apiPort: 3000        # HTTP API (API Gateway emulation)
+    invokePort: 3001     # direct Lambda invocations
 ```
 
-### 4. Workflow
-
 ```bash
-# 1. Start LSS Orchestrator
-npx lss start
-
-# 2. Package your microservice (auto-registers with LSS)
-cd your-microservice
+# 4. Package the service — the plugin auto-registers it with LSS
+#    (registration also fires on `sls offline` startup)
 npx sls package
 
-# 3. Monitor in the dashboard
+# 5. Watch everything in the dashboard
 open http://localhost:3100
 ```
 
-Now when you send a message to an SQS queue in LocalStack, the orchestrator will:
-1. Detect the event via event source mapping
-2. Invoke the Lambda proxy in LocalStack
-3. Proxy calls LSS's Lambda invoke listener on the service invoke port
-4. Your handler executes
+A minimal template lives at [docs/serverless.yml.example](docs/serverless.yml.example);
+complete runnable projects live in [examples/](examples/) — one per engine flavor:
 
-If you still want serverless-offline to own the ports for a service, disable the
-LSS runtime globally or per service with `lambdaRuntime.enabled`/`serviceRuntime`.
+| Example | Shows |
+| --- | --- |
+| [localstack-free](examples/localstack-free/) | LocalStack community 4.0 (Docker, no token): 3 services + a shared EventBridge bus — authorizers, SQS, schedules, DynamoDB stream → SNS, S3 notifications, seeds |
+| [localstack-ultimate](examples/localstack-ultimate/) | LocalStack Pro image (Ultimate plan, auth token) with the serverless-offline path preserved |
+| [self-hosted](examples/self-hosted/) | The no-Docker self engine end to end: orders → billing → notifications pipeline + an OpenSearch Serverless catalog |
 
-## Project Structure
+Each example ships an `index.html` validation console and its own dashboard
+branding — see [examples/README.md](examples/README.md) for the full port map and
+shared conventions.
 
-```
-local-serverless-stack/
-  bin/
-    cli.js              # CLI implementation (npx lss)
-  package.json          # Workspace root with bin config
-  packages/
-    orchestrator/       # Main orchestrator (Express + Vue UI)
-      server/           # Backend (TypeScript)
-      ui/              # Frontend (Vue 3 + Vite)
-      dist/            # Compiled output
-    serverless-plugin/ # Serverless Framework plugin
-      src/index.ts     # Plugin implementation
-      dist/            # Compiled plugin
-  docs/                # Documentation
+## CLI
+
+```bash
+npx lss start                  # start the orchestrator in background (managed LocalStack)
+npx lss start --self-engine    #   …with the in-process self engine (no Docker)
+npx lss start --external       #   …connecting to a LocalStack you already run
+npx lss start --pro            #   …with the LocalStack Pro image (needs auth token)
+npx lss start --pro --localstack-token ls-xxx  #   …passing the auth token inline
+npx lss start --enable-dynamo-proxy            #   …with the DynamoDB proxy on :8000
+npx lss start --config ./e2e/lss.config.json   # explicit config file (any command)
+npx lss status                 # is it running? which ports?
+npx lss logs                   # tail the orchestrator log
+npx lss seed [table]           # apply DynamoDB seed files (all tables or one)
+npx lss seed:clear [table] -y  # empty seeded tables (prompts unless --yes)
+npx lss stop                   # stop the orchestrator (and managed LocalStack)
+npx lss help                   # all commands, flags and a config template
 ```
 
-## Configuration
+```bash
+$ npx lss start --self-engine
+🚀 LSS Orchestrator started (PID: 12345)
+📊 Server: http://localhost:3100
+🔧 Self Engine: http://localhost:14566 (no Docker)
+✅ Service is running
+```
 
-### Environment Variables
+The CLI runs the orchestrator detached, storing the PID in
+`$TMPDIR/lss-orchestrator-{serverPort}.pid` and logs in
+`$TMPDIR/lss-orchestrator-{serverPort}.log` (no suffix for the default port 3100;
+under `stateDir` both move into that directory). The port-scoped paths let multiple
+LSS instances coexist — one per project — without trampling each other.
 
-- `PORT`: Orchestrator API port (default: 3100)
-- `LSS_ENGINE`: AWS engine — `localstack` (default) or `self` (in-process, no Docker)
-- `LSS_ENGINE_PORT`: Self engine port (default: 14566)
-- `ENABLE_DYNAMO_PROXY`: Enable DynamoDB proxy on port 8000 (default: false)
-- `DYNAMO_PROXY_PORT`: DynamoDB proxy port (default: 8000)
+## Configuration
 
-### Engine selection
+Create an `lss.config.json` in the directory where you run `lss start` (all keys
+optional — [full reference](docs/CONFIGURATION.md)):
 
 ```jsonc
-// lss.config.json
 {
-  "engine": "self",              // "localstack" (default) | "self"
-  "selfEngine": { "port": 14566 } // full reference: docs/SELF_ENGINE.md
+  "serverPort": 3100,                // dashboard + API
+  "engine": "localstack",            // "localstack" (default) | "self" (no Docker)
+  "selfEngine": { "port": 14566 },   // engine "self" settings — docs/SELF_ENGINE.md
+  "localstackPort": 4566,
+  "services": ["dynamodb", "sqs", "sns", "s3", "lambda", "events"],
+  "seedsDir": "./seeds",             // DynamoDB fixtures ({tableName}.json)
+  "autoPackage": false,              // run `sls package` on register when template is missing
+  "lambdaRuntime": { "enabled": true, "execution": "auto" },
+  "branding": {                      // dashboard look & feel (optional)
+    "title": "Acme Cloud",
+    "logo": "./assets/acme.svg",
+    "colors": { "brand-primary": "#e63946" }
+  }
 }
 ```
 
+The most common environment overrides (env always wins over the file):
+`LSS_DASHBOARD_PORT`, `LSS_ENGINE` (`localstack`/`self`), `LOCALSTACK_AUTH_TOKEN`,
+`LSS_ENABLE_DYNAMO_PROXY`. Complete list: [docs/CONFIGURATION.md](docs/CONFIGURATION.md#environment-variables).
+
 The self engine's default port sits **outside 4566–4599** on purpose: a real LocalStack
 install intercepts that whole range on some hosts (Docker Desktop/WSL2). `--self-engine`
 cannot be combined with the LocalStack-only flags (`--external`, `--pro`,
 `--localstack-token`).
 
-### LocalStack Settings
-
-LocalStack is configured with:
-- Services: `dynamodb,sqs,sns,s3,lambda,events`
-- Persistence: Enabled (volume: `lss-localstack-data`)
-- Lambda executor: `local` (no Docker-in-Docker required)
-- Docker socket: Mounted from host
-
-#### Managed vs external mode
-
-By default LSS spins up its own LocalStack container. To point at an already-running instance (e.g. one you're sharing across projects) set `mode: "external"` in `lss.config.json` or pass `--external`:
-
-```bash
-npx lss start --external                 # connect to whatever is on localstackEndpoint
-```
-
-#### Edition and auth token
+### LocalStack: managed, external, Pro
 
-Recent LocalStack images (`>= 2026.5` for community, all `pro` builds) require `LOCALSTACK_AUTH_TOKEN`. Provide it via env var (preferred) or `--localstack-token`:
+By default LSS spins up its own container (`lss-localstack-<port>`, services
+`dynamodb,sqs,sns,s3,lambda,events`, persistence volume, local Lambda executor). To point
+at an already-running instance set `mode: "external"` or pass `--external`. Recent
+LocalStack images (`>= 2026.5` community, all `pro`) require an auth token:
 
 ```bash
 export LOCALSTACK_AUTH_TOKEN=ls-xxxxxxxx
-npx lss start                            # community image with token
-npx lss start --pro                      # pro image (token required)
-```
-
-See [docs/CONFIGURATION.md](docs/CONFIGURATION.md) for the full reference (`mode`, `localstackEdition`, `localstackVersion`, `localstackImage`, `localstackAuthToken`).
-
-## Development
-
-### Build All Packages
-
-```bash
-npm run build
-```
-
-### Build Individual Packages
-
-```bash
-# Build orchestrator only
-npm run orchestrator:build
-
-# Build plugin only
-npm run plugin:build
-```
-
-### Watch Mode (Development)
-
-```bash
-# Orchestrator with hot reload
-npm run orchestrator:dev
-
-# Plugin with watch
-cd packages/serverless-plugin
-npm run dev
+npx lss start            # community image with token
+npx lss start --pro      # pro image (token required)
 ```
 
-## Testing
-
-LSS includes comprehensive integration tests covering CLI, Orchestrator API, and Plugin functionality.
-
-### Quick Start
-
-```bash
-# Run all tests
-npm test
-
-# Run with coverage
-npm run test:coverage
-
-# Run specific test suite
-npm run test:cli
-npm run test:orchestrator
-npm run test:plugin
-
-# Watch mode
-npm run test:watch
-```
-
-### Using Test Runner Script
-
-```bash
-# Run all integration tests
-./run-tests.sh
-
-# Run specific suite
-./run-tests.sh cli
-./run-tests.sh orchestrator
-./run-tests.sh plugin
-
-# Run with coverage
-./run-tests.sh coverage
-
-# Watch mode
-./run-tests.sh watch
-```
-
-### Test Coverage
-
-The test suite validates:
-
-✅ **CLI Commands**
-- `npx lss start` - Orchestrator startup
-- `npx lss stop` - Graceful shutdown
-- `npx lss status` - Status reporting
-- `npx lss logs` - Log viewing
-- `npx lss help` - Help information
+Details (`mode`, `localstackEdition`, `localstackVersion`, `localstackImage`):
+[docs/CONFIGURATION.md](docs/CONFIGURATION.md).
 
-✅ **Orchestrator API**
-- Service registration
-- Resource provisioning (DynamoDB, SQS, SNS)
-- Lambda proxy creation
-- Event source mappings
-- Error handling
+## Dashboard
 
-✅ **Serverless Plugin**
-- CloudFormation parsing
-- Resource creation in LocalStack
-- Service lifecycle management
+The Vue 3 dashboard at `http://localhost:3100` has seven tabs — **Overview** (health,
+config snapshot), **Services** (status, start/stop, live logs, per-service resource
+breakdown incl. EventBridge buses & rules), **Lambdas** (registry + invoke), **APIs**
+(emulated HTTP routes), **Queues** (send/receive/purge, consumers), **S3** (objects,
+upload/download), **DynamoDB** (items explorer, editor, TTL, seeds). A region selector
+lets you inspect resources in any region.
 
-See [tests/README.md](tests/README.md) for detailed test documentation.
+It can carry your team's identity via the `branding` config key: navbar title/subtitle,
+logo and favicon (URL or a file next to `lss.config.json`), default theme, and any
+[TreeUI](https://www.npmjs.com/package/@treeui/vue) color token per theme:
 
-## How It Works
-npm run orchestrator:dev
-
-# Plugin with watch
-cd packages/serverless-plugin
-npm run dev
+```jsonc
+"branding": {
+  "title": "Acme Cloud",
+  "subtitle": "Sandbox local",
+  "logo": "./assets/acme.svg",
+  "defaultTheme": "light",
+  "colors": { "brand-primary": "#e63946", "brand-hover": "#c1121f" },
+  "themeColors": { "dark": { "bg-primary": "#0d1b2a" } }
+}
 ```
 
 ## How It Works
 
-### Part 1: Initialization & Service Registration
+### Registration & provisioning
 
 ```mermaid
 sequenceDiagram
     participant Dev as Developer
-    participant CLI as LSS CLI
+    participant Plugin as serverless-lss<br/>(plugin)
     participant Orch as Orchestrator
-    participant LS as LocalStack
-    participant Plugin as Serverless Plugin
-    participant SLS as Serverless Offline
-
-    Note over Dev,SLS: 1. Start LSS Environment
-    Dev->>CLI: npx lss start
-    CLI->>Orch: Start orchestrator (port 3100)
-    Orch->>LS: Start LocalStack container (port 4566)
-    LS-->>Orch: Ready
-    Orch-->>CLI: ✅ Running (PID saved)
-    CLI-->>Dev: Dashboard: http://localhost:3100
-
-    Note over Dev,SLS: 2. Register Microservice
+    participant Eng as Engine<br/>(self or LocalStack)
+
     Dev->>Plugin: sls package
-    Plugin->>Plugin: Read CloudFormation template
     Plugin->>Orch: POST /api/services/register
-    Note right of Plugin: Sends: service name,<br/>CFN template,<br/>invoke port
-    
-    Orch->>Orch: Parse CloudFormation
-    Note right of Orch: Extract:<br/>- DynamoDB tables<br/>- SQS queues<br/>- SNS topics<br/>- Event Source Mappings
-
-    Note over Orch,LS: 3. Provision Resources
-    Orch->>LS: Create DynamoDB tables
-    LS-->>Orch: Tables created
-    Orch->>LS: Create SQS queues (+ DLQs)
-    LS-->>Orch: Queues created
-    Orch->>LS: Create SNS topics
-    LS-->>Orch: Topics created
-
-    Note over Orch,LS: 4. Create Lambda Proxies (on-demand)
-    loop For each Event Source Mapping
-        Orch->>Orch: Generate proxy Lambda code
-        Note right of Orch: Proxy points to<br/>Serverless Offline
-        Orch->>LS: Create Lambda proxy function
-        LS-->>Orch: Proxy created
-        Orch->>LS: Create Event Source Mapping
-        Note right of Orch: SQS/DynamoDB/SNS → Lambda
-        LS-->>Orch: Mapping active
-    end
-
-    Orch-->>Plugin: ✅ Service registered
-    Plugin-->>Dev: ✅ Provisioned resources
-
-    Note over Dev,SLS: 5. Start Application
-    Dev->>SLS: serverless offline start
-    Note right of SLS: Starts on port 3020<br/>Lambda invoke: 13020
-    SLS-->>Dev: ✅ Handlers ready
+    Note right of Plugin: Sends: servicePath,<br/>apiPort, invokePort, region
+    Orch->>Orch: Read + parse CloudFormation template<br/>from servicePath/.serverless/
+    Orch->>Eng: Create tables, queues, topics,<br/>buckets, buses, rules
+    Orch->>Eng: Wire event source mappings<br/>(SQS/streams/S3/EventBridge → Lambda)
+    Orch->>Orch: Start Lambda runtime worker<br/>+ API listener (30xx) + invoke listener (130xx)
+    Orch-->>Plugin: ✅ registered (N resources)
 ```
 
-### Part 2: Event Processing Flow
+The plugin itself only reports *where* the service lives — the orchestrator reads
+`.serverless/cloudformation-template-update-stack.json` from that path (running
+`sls package` generates it; `autoPackage: true` lets the orchestrator regenerate it
+on demand).
+
+### Event flow
 
 ```mermaid
 sequenceDiagram
     participant App as Application
-    participant SQS as SQS Queue<br/>(LocalStack)
-    participant LS as LocalStack
-    participant Proxy as Lambda Proxy<br/>(LocalStack)
-    participant SLS as Serverless Offline
-    participant Handler as Lambda Handler
-
-    Note over App,Handler: Message Processing Flow
-
-    App->>SQS: Send message to queue
-    Note right of App: AWS SDK configured<br/>to LocalStack endpoint
-    SQS-->>App: Message accepted
-
-    Note over SQS,LS: Event Source Mapping Active
-    LS->>SQS: Poll for messages (BatchSize: 1-10)
-    SQS-->>LS: Return message(s)
-
-    LS->>Proxy: Invoke Lambda proxy
-    Note right of LS: Event with Records[]:<br/>- SQS message body<br/>- Attributes<br/>- Message ID
-
-    Note over Proxy,SLS: Proxy Forwards to Serverless Offline
-    Proxy->>Proxy: Transform event if needed
-    Note right of Proxy: Ensure Records[] format
-    
-    Proxy->>SLS: HTTP POST /2015-03-31/functions/<br/>{functionName}/invocations
-    Note right of Proxy: Headers:<br/>- Content-Type: application/json<br/>- X-Amz-Invocation-Type
-
-    SLS->>Handler: Execute handler(event, context)
-    Note right of Handler: Real business logic<br/>runs here
-
-    alt Handler Success
-        Handler-->>SLS: Return response
-        SLS-->>Proxy: 200 OK + response body
-        Proxy-->>LS: Success
-        LS->>SQS: Delete message from queue
-    else Handler Error
-        Handler-->>SLS: Throw error
-        SLS-->>Proxy: 500 Error
-        Proxy-->>LS: Error
-        LS->>SQS: Return to queue or send to DLQ
-        Note right of SQS: Based on retry policy
+    participant Eng as Engine<br/>(SQS queue)
+    participant RT as LSS Lambda runtime
+    participant H as Your handler
+
+    App->>Eng: SendMessage (AWS SDK)
+    Eng->>RT: Event batch {Records: [...]}
+    Note over Eng,RT: self engine: in-process dispatch<br/>LocalStack: proxy Lambda → HTTP → invoke listener
+    RT->>H: handler(event, context)
+    alt success
+        H-->>RT: return
+        RT-->>Eng: ok → message deleted
+    else error
+        H-->>RT: throw
+        RT-->>Eng: fail → redelivery / DLQ
     end
-
-    Note over App,Handler: Processing Complete
 ```
 
-### Detailed Explanation
-
-1. **Service Registration**:
-   - Developer runs `sls package` in their microservice
-   - Plugin reads `.serverless/cloudformation-template-update-stack.json`
-   - Plugin POSTs to orchestrator `/api/services/register` with service metadata
-
-2. **Resource Provisioning**:
-   - Orchestrator parses CloudFormation template
-   - Extracts DynamoDB tables, SQS queues, SNS topics
-   - Creates resources in LocalStack via AWS SDK
-   - **Only creates Lambda proxies when Event Source Mappings exist**
-   - Generates proxy code that forwards to serverless-offline invoke endpoint
-   - Creates event source mappings (SQS/DynamoDB/SNS → Lambda)
-
-3. **Event Flow**:
-   - Message arrives in SQS queue
-   - LocalStack polls queue via event source mapping
-   - Lambda proxy is triggered automatically
-   - Proxy transforms event and makes HTTP POST to serverless-offline
-   - Real handler executes in serverless-offline process
-   - Response returned through proxy chain
-   - Message deleted from queue on success, or sent to DLQ on failure
-
-> **Self-engine mode collapses this whole chain**: the engine's event source mapping
-> delivers the SQS batch **in-process** to the LSS Lambda runtime — no LocalStack
-> polling, no proxy Lambda, no HTTP hop:
->
-> ```
-> LocalStack mode:  SQS → LocalStack ESM → proxy Lambda (container) → HTTP → handler
-> Self engine:      SQS (engine) → dispatcher → handler
-> ```
->
-> The same applies to DynamoDB streams, S3 notifications and EventBridge targets.
-
-## CLI Implementation Details
-
-The `npx lss` CLI is implemented in `/bin/cli.js` and provides:
-
-- **Background Process Management**: Uses `spawn` with `detached: true` to run orchestrator independently
-- **PID File**: Stores process ID in `/tmp/lss-orchestrator-{serverPort}.pid` (or `/tmp/lss-orchestrator.pid` when serverPort is the default 3100). The port-scoped path lets multiple LSS instances coexist — one per project — without trampling each other.
-- **Log File**: Redirects stdout/stderr to `/tmp/lss-orchestrator-{serverPort}.log` (or `/tmp/lss-orchestrator.log` for the default port).
-- **Process Monitoring**: Checks if process is alive before starting/stopping
-- **Clean Shutdown**: Sends SIGTERM for graceful termination
-
-### Files
-
-- **PID File**: `/tmp/lss-orchestrator-{serverPort}.pid`
-- **Log File**: `/tmp/lss-orchestrator-{serverPort}.log`
+The same flow applies to DynamoDB streams, S3 notifications and EventBridge targets.
+In LocalStack mode the hop goes through a generated proxy Lambda inside the container;
+in self-engine mode the dispatcher calls the runtime directly — no proxy, no polling.
 
-## Troubleshooting
-
-### Check Logs
+If you still want serverless-offline to own the ports for a service, disable the
+LSS runtime globally or per service with `lambdaRuntime.enabled`/`serviceRuntime`.
 
-```bash
-npx lss logs
+## Architecture
 
-# Or directly
-tail -f /tmp/lss-orchestrator.log
 ```
+local-serverless-stack/
+├── bin/cli.js                # CLI entry point (npx lss)
+├── src/
+│   ├── server/               # Express API + orchestration
+│   │   ├── routes/           # HTTP endpoints (/api/services, /api/queues, …)
+│   │   ├── services/         # provisioner, registrar, packager, seeds, …
+│   │   ├── engine/           # self engine (in-process AWS emulation)
+│   │   ├── runtime/          # Lambda runtime + API Gateway emulation
+│   │   └── dev/              # dev utilities (DynamoDB proxy)
+│   ├── client/               # programmatic client (LssClient) — package entry point
+│   └── ui/                   # Vue 3 dashboard (npm workspace, @treeui/vue)
+├── packages/serverless-plugin/  # serverless-lss (published separately)
+├── docs/                     # reference docs
+├── examples/                 # runnable sample projects
+└── tests/                    # unit + integration suites
+```
+
+- **CLI** (`bin/cli.js`): background process management (start/stop/status/logs/seed)
+- **Server** (`src/server/`): Express API + engine orchestration; serves the built UI
+- **Engine** (`src/server/engine/`): the AWS provider behind everything — in-process **self engine** (:14566, no Docker) or managed/external **LocalStack** (:4566)
+- **Client** (`src/client/`): `LssClient` — the same API surface as the dashboard, from code
+- **Plugin** (`packages/serverless-plugin/`): auto-registration on `sls package`
 
-### Orchestrator Won't Start
+## Development
 
 ```bash
-# Check if already running
-npx lss status
-
-# Check if build is complete
-ls -la /workspaces/local-serverless-stack/dist/server/
-ls -la /workspaces/local-serverless-stack/dist/ui/
-
-# Rebuild if needed
-npm run build
+git clone https://github.com/viserion77/local-serverless-stack.git
+cd local-serverless-stack
+npm run setup          # install root + UI workspace deps
+npm run dev            # server (tsx watch) + UI (vite) concurrently
+npm run build          # ui + server + client + plugin
 ```
 
-### Port Already in Use
+Granular builds: `server:build`, `ui:build`, `client:build`, `plugin:build`.
 
-The orchestrator uses port 3100 by default. If this port is in use:
+### Testing
 
 ```bash
-# Find process using port 3100
-lsof -i :3100
-
-# Kill if needed
-kill -9 <PID>
+npm test                    # unit suite (jest)
+npm run test:coverage       # with coverage (CI gate)
+npm run test:watch          # watch mode
+npm run test:integration    # boots a real orchestrator (Docker/LocalStack required)
+npm run lint                # eslint
+npx jest tests/unit/services/config-manager.test.ts   # a single suite
 ```
 
-## Optional Features
-
-### DynamoDB Proxy (Port 8000)
-
-The orchestrator includes an optional reverse proxy on port 8000 that forwards to LocalStack (4566).
+## Troubleshooting
 
-Enable with:
 ```bash
-ENABLE_DYNAMO_PROXY=true npm run server:dev
+npx lss status          # running? which ports?
+npx lss logs            # orchestrator log (also: $TMPDIR/lss-orchestrator*.log)
+ls dist/server dist/ui  # built? if not: npm run build
+lsof -i :3100           # who owns the port?
 ```
 
-Located in: `src/server/dev/dynamo-proxy.ts`
-
-## Project Status
+- **Plugin registers nothing** → is `orchestratorUrl` pointing at the right `serverPort`? Try `ORCHESTRATOR_URL=http://localhost:3100 npx sls package`.
+- **Ports 4566–4599 behave strangely** → a real LocalStack install may intercept the whole range; the self engine defaults to 14566 for this reason.
+- **DynamoDB on port 8000 expected by your tooling** → enable the proxy: `lss start --enable-dynamo-proxy` (or `enableDynamoProxy: true`); it forwards to the active engine.
 
-⚠️ **Version 0.1.0 - Internal Development**
+## Contributing & Releasing
 
-This project is currently in active development and is being used internally. It is not yet published to npm.
-
-### Completed Features
-
-- ✅ CLI with start/stop/status/logs commands
-- ✅ Background process management
-- ✅ Serverless Framework plugin
-- ✅ Auto-provisioning of AWS resources
-- ✅ Event source mapping (SQS → Lambda)
-- ✅ Web dashboard (Vue 3)
-- ✅ npm link support for local development
-
-## Use Case Example
-
-LSS can be used in monorepo setups to manage 15+ microservices with a single LocalStack instance. This eliminates the complexity of running multiple LocalStack containers and provides a unified development experience.
-
-Integration approach:
-- Place LSS in a dedicated directory (e.g., `/workspaces/local-serverless-stack`)
-- Use `npm link` for local development and seamless updates
-- Install the plugin in each microservice that needs AWS resource orchestration
-- Orchestrator managed via `npx lss start/stop` commands
-
-## Contributing
-
-Contributions welcome! This is an open-source project designed to simplify local serverless development.
+Contributions welcome — see [CONTRIBUTING.md](CONTRIBUTING.md). Release process
+(automated npm publish on version bump): [docs/RELEASE.md](docs/RELEASE.md).
+Changelog: [CHANGELOG.md](CHANGELOG.md).
 
 ## License
 
 MIT
-
-## Publishing to npm
-
-⚠️ **For maintainers only**
-
-### Automatic Publishing (Recommended)
-
-The project uses GitHub Actions for automatic publishing to NPM when you update the version:
-
-**1. Update version in package.json**:
-```bash
-# For the root package (CLI + orchestrator)
-npm version patch  # 0.0.1 -> 0.0.2
-npm version minor  # 0.0.1 -> 0.1.0
-npm version major  # 0.0.1 -> 1.0.0
-```
-
-**2. Push to main branch**:
-```bash
-git add package.json CHANGELOG.md
-git commit -m "chore: bump version to 0.0.2"
-git push origin main
-```
-
-**3. GitHub Actions will automatically**:
-- ✅ Detect version change
-- ✅ Run full test suite
-- ✅ Build the project
-- ✅ Publish to NPM
-- ✅ Create a git tag (e.g., `v0.0.2`)
-
-### Plugin Package
-
-To publish the serverless plugin separately:
-
-```bash
-cd packages/serverless-plugin
-npm version patch
-cd ../..
-git add packages/serverless-plugin/package.json
-git commit -m "chore(plugin): bump version to 0.0.2"
-git push origin main
-```
-
-### Required Setup (One-time)
-
-Before automatic publishing works:
-
-1. **NPM Access Token**:
-   - Go to npmjs.com → Access Tokens → Generate New Token
-   - Select "Automation" type
-   - Copy the token
-
-2. **GitHub Secret**:
-   - Go to your repo → Settings → Secrets and variables → Actions
-   - Add new repository secret: `NPM_TOKEN`
-   - Paste your NPM token
-
-### Pre-publish Checklist
-
-1. ✅ All tests passing
-2. ✅ Build successful (`npm run build`)
-3. ✅ Version updated in `package.json`
-4. ✅ CHANGELOG.md updated
-5. ✅ README.md updated
-6. ✅ No breaking changes (or properly documented)
-
-### Manual Publishing (Emergency Only)
-
-If GitHub Actions fails, you can publish manually:
-
-```bash
-# 1. Ensure clean working directory
-git status
-
-# 2. Build all packages
-npm run build
-
-# 3. Test the package contents
-npm pack
-tar -tzf local-serverless-stack-*.tgz
-
-# 4. Publish to npm (dry-run first)
-npm publish --dry-run
-
-# 5. Publish for real
-npm publish --access public
-
-# 6. Create git tag
-git tag v0.0.1
-git push origin v0.0.1
-```
-
-### What Gets Published
-
-The `files` field in package.json controls what's published:
-
-- `bin/` - CLI scripts
-- `dist/` - Compiled server + UI
-- `packages/serverless-plugin/dist/` - Compiled plugin
-- `README.md`, `LICENSE`, `CHANGELOG.md`
-
-Source files and development dependencies are **not** included.
-
-### Post-publish
-
-After publishing, users can install with:
-
-```bash
-npm install local-serverless-stack
-npx lss start
-```
-
-No build step required for end users!