note-form-generator
v0.1.0
Published
A note form generator without dependencies made in JavaScript and HTML
Downloads
4
Readme
NFG
A note form generator without dependencies made in JavaScript and HTML
Installation
Prerequisites: Node.js (16+) and npm.
Install dependencies:
cd D:\GitHub\NFG
npm installIf you encounter peer dependency errors on older npm versions, you can run:
npm install --legacy-peer-depsRunning Tests
Run the test suite once:
npm testRun Jest in watch mode (re-runs on file changes):
npm run test:watchCode Style / CS-Fixer
This project uses Prettier and ESLint. A convenience fixer script is provided:
npm run cs-fixerRun only Prettier formatting:
npm run cs-fixer:prettierRun only ESLint auto-fixes:
npm run cs-fixer:eslintContributing
- Fork the repo and open a branch for your changes.
- Run
npm installand make sure tests pass:npm test. - Run the fixer before opening a PR:
npm run cs-fixer. - Keep changes focused and add tests for bug fixes or new features.
- Prefer small, well-described commits and include a clear PR description.
Notes
ESLint uses a flat config (
eslint.config.js) compatible with ESLint v9+.If you have permission issues installing dependencies on Windows, run an elevated PowerShell and re-run
npm install.Runtime: This project does not require any external services or runtime dependencies to function — the packaged HTML/JS runs standalone in a browser or embedded environment. The Node.js packages in
devDependenciesare provided only to assist development (testing, linting, formatting).
