startkit

A minimal project template for new libraries.

startkit gives you a publish-ready library with nothing beyond the essentials: a test runner, a linter, and a release script. Run it, rename it, and ship.

Usage

Clone the repository and scaffold a new library:

git clone https://github.com/libnudget/startkit
cd startkit
npm install
npm link        # makes the `startkit` command available
startkit mylib  # creates ./mylib from the template

Or without installing anything:

npx --yes github:libnudget/startkit mylib

Then move in and get going:

cd mylib
npm install
npm test

What you get

• An ESM library with a src/ module and a node:test test suite.
• ESLint with a minimal flat config.
• A CI workflow that runs lint and tests on every push.
• README, CHANGELOG, LICENSE, and .gitignore.

Development

npm test
npm run lint

License

MIT