Skip to content
eliwarePublic

Repository files navigation

eliware.org

@eliware/core npm License CI

Core Networking Manager.

Table of Contents

Features

core-cli validates and compares router configuration repositories. core-web provides a read-only dashboard, health monitoring, metrics, and GitHub deployment hooks.

Requirements

Use Node.js 26 or later. Install Bash when the router repository contains shell scripts.

Setup

Install Core as a development dependency in each router configuration repository:

npm install --save-dev @eliware/core@latest

Follow the router installation guide to prepare a router host.

Usage

Run core-cli preflight to validate one router repository. Run core-cli compare <partner-repo> to validate a router pair. Read the CLI guide and web application guide for details. Read release notes for version history.

Development

Run npm ci from this repository root. Read AGENTS.md, the documentation index, and the specifications index before you change files.

Testing

Run npm test for aggregate checks with the browser build. Run npm run build to build browser bundles directly. Run the browser checks separately with npm run screenshots or npm run lighthouse.

Troubleshooting

Read the CLI guide for validation errors. Read the installation guide for host setup problems. Read the web application guide for server and webhook problems.

Security

Keep credentials, private data, and runtime state out of Git. Limit dashboard and webhook access with the router firewall or an approved proxy.

Configuration

The web application reads environment values and .env from its working directory. Read the configuration guide for variable defaults and requirements.

Operations

Use the router installation guide to install services and configuration links. Read the web application guide for dashboard and deployment operations.

Commands

Command Purpose
core-cli preflight Validate one router repository.
core-cli compare <partner-repo> Validate a router pair.
core-cli catalog List catalog components.
core-cli status [component] [--repo <path>] Check component health units.
core-cli reload [component] [--repo <path>] Run component reload actions.
core-web Start the dashboard and webhook application.

Run core-cli --help or core-web --help for command help. Run core-cli --version or core-web --version for the package version. Read the CLI guide for arguments, defaults, and command results.

Exit codes

The CLI commands return these codes:

Code Meaning
0 The command completed successfully.
1 Repository validation or an operation failed.
2 The command received invalid syntax or an unsupported option.

Routes

The dashboard serves /, /health, /ready, and /api/status. The webhook listener accepts POST /api/github/webhook on its configured port. Read the route guide for assets and response details.

Assets

Keep browser source files in src/frontend/ and served assets in public/. The build creates dist/client.js and dist/service-worker.js as local build artifacts. The npm package excludes dist/ and ships browser bundles from public/. The prepack script rebuilds those bundles before npm pack or npm publish. Run node bin/copy-web-assets.mjs after a manual build to refresh local assets.

Development server

Run core-web from a router repository. The dashboard defaults to loopback port 9300, and the webhook defaults to loopback port 9301. Read the web application guide for proxy settings.

Build

Run npm run build to create browser bundles in dist/. Run node bin/copy-web-assets.mjs to update the packaged browser assets. Read the browser validation guide for browser checks.

Deployment

The webhook validates signed GitHub push events and runs configured deployment steps in order. Read the deployment guide for validation and recovery details.

Support

For help, questions, or to chat with the author and community, visit:

Discordeliware.org

eliware.org on Discord

Links

License

MIT © Eliware

Releases

Packages

Contributors

Languages