Developer resources
- Qworum specification: The target audience for this specification are the developers of Qworum applications and services.
- JavaScript library documentation: Web pages use this ES6 module for accessing the advanced Qworum capabilities of web browsers.
- The issues page of the JavaScript library.
- JavaScript library source code (GitHub).
- Application template (GitHub). A simple versioned multi-language template for Qworum-based web applications/APIs.
- Email support.
Downloads
Developing with Qworum
Qworum services must not add new entries to browser tab histories. To ensure this, Qworum applications must be launched by clicking on a link in another tab, such as this one.
This constraint is needed because being able to use the browser's forward/backward buttons can cause the Qworum session state to go out of sync with the UI that the end-user sees. As a developer, you have the option of leaving your non-Qworum application unchanged and providing a separate Qworum API for calling third-party services and being called by them. Alternatively, you can transform your Web application into a Qworum application and, even better, develop a Qworum application from scratch. Transforming any Web application into a valid Qworum application is a simple matter of making sure that the application does not add new entries to the browser's tab history. At this point your application will have become a valid Qworum API consisting of one endpoint. You can then factor out parts of your monolithic application into separate endpoints. Through refactoring you will then be able to build complex user flows by orchestrating these endpoints. Refactoring also will allow you to make parts of your user flows available to third-party applications.
Transforming web applications into Qworum services
Local development
The Qworum browser extension is enabled for local development by default. The web origins that are enabled for local development are:
http://localhost:8080,http://27.0.0.1:8080(the TCP port 8080 is often used in the Java world)http://localhost:3000,http://27.0.0.1:3000(port 3000 is often used in Deno or Node.js projects)http://localhost:5500,http://27.0.0.1:5500(5500 is the default port for VS Code's Live Server extension)http://localhost:5501,http://27.0.0.1:5501(alternative Live Server port)http://localhost:5502,http://27.0.0.1:5502(alternative Live Server port)