https://github.com/ryanmorr/js-boilerplate
Minimal boilerplate for Node.js and universal JavaScript projects
https://github.com/ryanmorr/js-boilerplate
boilerplate javascript starter-kit
Last synced: about 1 year ago
JSON representation
Minimal boilerplate for Node.js and universal JavaScript projects
- Host: GitHub
- URL: https://github.com/ryanmorr/js-boilerplate
- Owner: ryanmorr
- License: unlicense
- Created: 2016-05-27T17:29:48.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T16:18:44.000Z (over 1 year ago)
- Last Synced: 2025-04-09T16:09:28.624Z (about 1 year ago)
- Topics: boilerplate, javascript, starter-kit
- Language: JavaScript
- Homepage:
- Size: 313 KB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# js-boilerplate
> Minimal boilerplate for Node.js and universal JavaScript projects.
## Features
* Bundle modules with [Rollup](https://rollupjs.org) and generate a build for each of [CJS](http://www.commonjs.org/), [ESM](https://v8.dev/features/modules), and [UMD](https://github.com/umdjs/umd)
* Code linting courtesy of [ESLint](http://eslint.org/)
* Unit testing with [Mocha](http://mochajs.org/), [Chai](http://chaijs.com/), and [Sinon](http://sinonjs.org/)
* Code minification via [terser](https://github.com/terser/terser)
* Includes support for continuous integration testing via [GitHub Actions](https://github.com/features/actions)
* Automatically includes a (configurable) banner to the distributed builds
## Setup
1. Run `npm install` to install the developmental dependencies
2. Open `package.json` and change the relevant fields: `name`, `description`, `homepage`, etc.
3. Open `rollup.config.js` and make the necessary changes to reflect your preferences
## Commands
* `npm test` - Run unit tests
* `npm run lint` - Lint source files and test specs
* `npm run build` - Bundle, transpile, and minify the source into the distributed builds
## License
This project is dedicated to the public domain as described by the [Unlicense](http://unlicense.org/).