Edit me on GitHub

Development

Welcome to the developer documentation of Converse.js.

Here you will learn how to add new features and how you can create your own customized version of Converse.

Converse is a community project and largely volunteer driven.

We’re grateful for your contributions, so please don’t hesitate to make a Github pull request to fix a bug or to add new functionality.

• Dependencies
  • Installing the 3rd party dependencies
  • Brief description of Converse’s dependencies
• Software Style Guide
  • Tabs or spaces?
  • Underscores or camelCase?
  • Spaces around operators
  • Global constants are written in ALL_CAPS
  • Function declaration and invocation
  • Checking for equality
  • Curly brackets
• Writing a plugin
  • Introduction
  • Advantages of plugins
  • Registering a plugin
  • Whitelisting of plugins
  • Security and access to the inner workings
  • Overrides
  • Plugin dependencies
  • Extending Converse’s configuration settings
  • Exposing promises
  • Dealing with asynchronicity
  • A full example plugin
• The API documentation (generated with JSDoc)
• Automated tests
  • Running tests
• Integrating converse.js into other frameworks
  • Angular.js
• Generating builds
  • Creating JavaScript and CSS bundles and distribution files
  • Creating custom bundles