example / Documentation • Contributing • Changelog
Welcome to new contributors! This project is open to input & edits.
Please use the dedicated form.
- Fork example.
- Commit your changes to the fork.
- Create a pull request.
If you want to implement a new feature, please get in touch first: Keybase, Telegram, Email.
src/
: JS source code.web/
: JS bundled code (generated at build time, commited in a submodule).
Clone:
git clone https://git.cosmic.plus/example
Commit:
npm run lint
git ci ...
Please sign your commits with your PGP key.
Release:
First of all update the package version into package.json
.
export version={semver}
npm run make-release
npm run publish-release
Please sign your commits and tags with your PGP key.
Those helpers require a POSIX shell.
npm run lint
: Lint code.npm run clean
: Clean theweb/
directory.npm run watch
: Automatically transpile & bundle code after each change.npm run serve
: Run a live server that updates after each change.npm run build
: Build the production transpiled code & browser bundle.npm run check
: Check the production browser bundle integrity.version={semver} npm run make-release
: Build & locally commit release.version={semver} npm run publish-release
: Check, tag, push & publish release.