A reusable Node.js application baseline for Eliware projects.
- Features
- Requirements
- Setup
- Usage
- Development
- Testing
- Troubleshooting
- Security
- Configuration
- Operations
- 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 sample has no required settings. LOG_LEVEL defaults to info.
Set LOG_LEVEL to error, warn, info, http, verbose, debug, or silly. Copy .env.example to an untracked .env file for local settings.
Run node bin/application-template.mjs to start the sample. It loads settings and registers process handlers. It does not open a listener.
Build a local image with docker build -t application-template ..
Template setup — update these values after you create an application repository.
This template has no published image. Set the image visibility to public or private. Set who can pull it. The workflow builds
linux/amd64; confirm or change the supported architectures. Name the owner for build inputs and architecture decisions. Update this section and the publication workflow before you publish an image.
Deploy with an approved version tag and its recorded SHA-256 digest. Publication does not deploy the application.
For help, questions, or to chat with the author and community, visit:
