Skip to content
eliwarePublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

eliware.org

@eliware/core npm License CI

Core Networking Manager.

Table of Contents

Features

Eliware maintains @eliware/core. The package validates and compares router configurations and provides a read-only status dashboard.

Core provides core-cli for router configuration validation and core-web for status and deployment hooks.

Requirements

Use Node.js 26 or later. Install Bash when router repositories contain shell scripts.

Setup

Run npm ci from this repository root. Install @eliware/core as a development dependency in each router repository.

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

Usage

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

Development

Read AGENTS.md for contributor instructions. Use the documentation index and specifications index to find maintained guidance.

Testing

Run npm test for aggregate repository validation. npm test runs the configured eliware-test checks. It does not build browser assets. Run npm run build after changing frontend source files. Run browser checks separately.

Troubleshooting

Read the CLI guide for validation errors. Read the web application guide for server and webhook issues.

Security

Keep credentials, private data, and runtime state out of Git. Allow proxy and firewall access from approved clients because the application has no authentication.

Configuration

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

Operations

Configure the dashboard and webhook listener using the web application guide. Push router repositories separately when deployments require different timing.

Commands

Run core-cli --help or core-web --help for command help. Run core-cli --version or core-web --version for the package version. Run core-web from a router repository to start the web application.

Exit codes

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

Routes

The dashboard listener serves its page, assets, health, readiness, and status routes. The server registers health, readiness, and status routes on that same listener. The webhook listener accepts POST /api/github/webhook on its configured port. Read the route guide for paths and results.

Assets

Keep browser source assets in public/. The build creates dist/client.js and dist/service-worker.js.

Development server

Run core-web from a router repository. The dashboard defaults to port 9300, and the webhook listener defaults to port 9301.

Build

Run npm run build to create browser bundles in dist/. Read the browser validation guide for screenshot and audit commands.

Deployment

The webhook checks signed pushes and runs deployment steps in order. Read the deployment guide for validation and recovery details. Use .github/workflows/npm.yaml and the approved release process to publish the package.

Support

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

Discordeliware.org

eliware.org on Discord

Links

License

MIT © Eliware

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages