@ibgib/space-gib 0.0.26 → 0.0.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -50,6 +50,21 @@ npm run restart:space-gib
50
50
  > **STRICT RULE**: `src/common` MUST NEVER import from `src/client` or `src/server`. This ensures the shared layer remains portable and prevents circular dependencies.
51
51
  * [`dist/`](dist/): The output directory where `esbuild` writes the bundled client (`dist/client/`) and server (`dist/server/`) code.
52
52
 
53
+ ## 🗺️ Reference Implementation Map
54
+
55
+ Space-Gib serves as the concrete reference implementation for the architectural patterns described in the [IbGib Developer Guides](../../docs/CREATING_IBGIB_APPS_GUIDE.md). Use this map to navigate directly from guide concepts to working code:
56
+
57
+ | Guide Concept | Conceptual Guide | Concrete Reference in `space-gib` |
58
+ |---|---|---|
59
+ | **Client 3-Tier Bootstrap** | [Client Guide: Bootstrap](../../docs/IBGIB_CLIENT_APPS_GUIDE.md#1-the-three-tier-bootstrap-architecture) | [`src/client/bootstrap.mts`](src/client/bootstrap.mts) & [`src/client/index.mts`](src/client/index.mts) |
60
+ | **Keystone Web Components** | [Client Guide: Identity Components](../../docs/IBGIB_CLIENT_APPS_GUIDE.md#4-zero-boilerplate-identity-components-web-gib) | [`src/client/index.html`](src/client/index.html) & [`src/client/bootstrap.mts`](src/client/bootstrap.mts) |
61
+ | **Client App Configuration** | [Client Guide: APP_CONFIG](../../docs/IBGIB_CLIENT_APPS_GUIDE.md#3-configuration-pattern-app_config--remotes) | [`src/client/constants.mts`](src/client/constants.mts) & [`src/client/helpers.web.mts`](src/client/helpers.web.mts) |
62
+ | **Server Runner & Pipeline** | [Server Guide: Serve-Gib Microframework](../../docs/IBGIB_SERVER_APPS_GUIDE.md#1-architecture--the-serve-gib-microframework) | [`src/server/server.mts`](src/server/server.mts) |
63
+ | **Shared Policies & Contracts** | [App Guide: Identity Security Profiles](../../docs/CREATING_IBGIB_APPS_GUIDE.md#3-identity-security-profiles--keystone-policies) | [`src/common/keystone-policies.mts`](src/common/keystone-policies.mts) & [`src/common/keystone-policies.json`](src/common/keystone-policies.json) |
64
+ | **WebSocket Sync Upgrade** | [Server Guide: Real-Time Sync Upgrade](../../docs/IBGIB_SERVER_APPS_GUIDE.md#5-real-time-websocket-sync-upgrade) | [`src/server/server.mts`](src/server/server.mts) |
65
+ | **Email Infrastructure** | [Server Guide: Email Infrastructure](../../docs/IBGIB_SERVER_APPS_GUIDE.md#6-email-infrastructure-ses--custom-addresses) | [`src/server/handlers/api/email/`](src/server/handlers/api/email/) |
66
+ | **Docker & Traefik Setup** | [Server Guide: Local Docker Development](../../docs/IBGIB_SERVER_APPS_GUIDE.md#7-local-docker-development--sso-loopback) | [`docker-compose.yml`](docker-compose.yml) & [`Dockerfile`](Dockerfile) |
67
+
53
68
  ## Debugging the Server
54
69
 
55
70
  You can attach the VS Code debugger directly to the Node.js process running inside Docker.