https://github.com/hugodf/node-mit-boilerplate
Node.js starter files with MIT license, gitignore and XO linting
https://github.com/hugodf/node-mit-boilerplate
mit-license node-starter nodejs nodejs-template prettier
Last synced: 27 days ago
JSON representation
Node.js starter files with MIT license, gitignore and XO linting
- Host: GitHub
- URL: https://github.com/hugodf/node-mit-boilerplate
- Owner: HugoDF
- License: mit
- Created: 2019-07-28T19:53:18.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T23:19:20.000Z (6 months ago)
- Last Synced: 2025-03-18T07:51:46.496Z (about 1 month ago)
- Topics: mit-license, node-starter, nodejs, nodejs-template, prettier
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [Project Name]
Boilerplate repo with:
- MIT License
- Node, npm
- tests with the `node:test` built-in
- formatting with prettier
- GitHub Actions on commit and to auto-publish on GH release
- **note**: for publish to work, `NPM_TOKEN` has to be set in the repository GH Actions secrets
## Requirements
- Node 20
- npm v8+
## Setup
1. Clone the repository
2. Run `npm install` installs all required dependencies.
## npm scripts
- `npm test` will run tests using the [Node.js test runner](https://nodejs.org/api/test.html#running-tests-from-the-command-line) and the `node:test` module.
- `npm run format` will run prettier on all the examples files (and tests).
## LICENSE
Code is licensed under the [MIT License](./LICENSE).