gitter-sidecar
v1.5.0
Published
An embeddable Gitter client.
Downloads
200
Keywords
Readme
Sidecar
Gitter embed widget, sidecar.gitter.im
Changelog
Usage
<script>
((window.gitter = {}).chat = {}).options = {
room: 'gitterHQ/sidecar-demo'
};
</script>
<script src="sidecar.js"></script>
Module Usage
There is also a standalone package available on npm gitter-sidecar
that doesn't pollute the global scope.
var Sidecar = require('gitter-sidecar');
var myChat = new Sidecar({
room: 'gitterHQ/sidecar-demo'
});
API
Build
- Build the Sidecar library:
npm run build
, output:./dist/sidecar.js
- Build Sidecar module/package:
npm run build-module
, output:./dist/sidecar-module.js
Dev
Same as devbuild
but also watches the directory and rebuilds on any file changes
npm run devbuild
Build Microsite
npm run build-microsite
Dev
This is currently a work in progress. But I hope to have react-hot-loader
and webpack-dev-server
working for this:
npm run devbuild-microsite
Deploy: Push Release
We have CircleCI setup, the config is in circle.yml
.
To push a new version of the sidecar script, run the following:
npm version patch
: bump version and tag itgit push --tags
: Trigger CircleCI build
To push a new release of microsite, just push to the master
branch
Manual Deployment
You'll need AWS credentials exported as AWS_KEY
and AWS_SECRET
. This command is not meant to be run locally, only by the CircleCI deployment step (on every tag).
npm run deploy
Testing
npm test
Contributing
We use git-flow. Merge requests should be made against develop
not master
.
Please join us in gitterHQ/contributing for questions or to get in touch.