A reusable starting point for Eliware Node.js libraries using native ESM.
- Features
- Requirements
- Setup
- Usage
- Development
- Testing
- Troubleshooting
- Security
- API
- Packaging
- Examples
- Support
- Links
- License
This template provides a reusable starting point. Each derived repository owns its product behavior and operating decisions.
Use Node.js 26 or later and npm 12 or later for repository validation.
Create a repository from this template. Replace the template name, description, URLs, keywords, and sample content.
Run npm ci from the repository root.
Follow this README and the user guide. Read release notes for release history.
Read AGENTS.md and the specifications index before you change files. Keep documents and records in the repository that owns them.
Run npm test before handoff. It runs the repository checks through eliware-test.
Install the required Node.js and npm versions. Run npm ci after dependency changes.
Review the file and rule in any validation error.
Keep credentials, secrets, private data, and runtime state out of Git. Use only approved secret stores for secret values.
The public function is createGreeting(name?: string): string.
Call createGreeting("Eli") to return Hello, Eli!. Call it with no name to return Hello, world!.
The package allowlist is src/, docs/, README.md, AGENTS.md, LICENSE, RELEASE_NOTES.md, examples/, and specs/.
Run npm run pack to check package contents. Publish only after approved release steps.
Run node examples/basic.mjs to see the sample API. See example guidance.
For help, questions, or to chat with the author and community, visit:
