https://github.com/coldbox-modules/cbpush
cbpush brings simplified websocket support to ColdBox applications using services such as Pusher, Ably, and Soketi.
https://github.com/coldbox-modules/cbpush
Last synced: 4 months ago
JSON representation
cbpush brings simplified websocket support to ColdBox applications using services such as Pusher, Ably, and Soketi.
- Host: GitHub
- URL: https://github.com/coldbox-modules/cbpush
- Owner: coldbox-modules
- License: apache-2.0
- Created: 2022-12-12T15:43:41.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-14T20:12:34.000Z (about 3 years ago)
- Last Synced: 2025-07-14T19:07:03.044Z (11 months ago)
- Homepage:
- Size: 1.22 MB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cbpush
[](https://github.com/coldbox-modules/cbpush/actions/workflows/ci.yml)
cbpush brings simplified websocket support to ColdBox applications using services such as Pusher, Ably, and Soketi.
## Short Pitch
Build reactive apps easily using CFML and less JavaScript!
## Longer Pitch
## Requirements
- Adobe CF 2018+ or Lucee 5+
- ColdBox 6+
## Installation
Install [CommandBox](https://www.ortussolutions.com/products/commandbox), then from your terminal, run:
```bash
box install cbpush@be
```
## Examples
Included in this repo is an app where you can experience and see code examples covering all the features of cbpush.
Just run the following from the `test-harness` directory:
```
box install && cd .. && box server start
```
Then visit:
http://localhost:60299/
## Contributing
We love PRs! Please create a ticket using the [ Issue Tracker](https://github.com/coldbox-modules/cbpush/issues) before submitting a PR.
## Test Harness
There is a test harness application included in this repo.
To start the test harness:
```
cd test-harness
box install
box server start
```
This will start the test harness using a random port selected by CommandBox. For example, if the random port selected is 60299, you can run the test suite using http://127.0.0.1:60299/tests.
## License
Apache License 2.0
## Credits
The cbpush module for ColdBox is written and maintained by [Grant Copley](https://twitter.com/grantcopley) and [Ortus Solutions](https://www.ortussolutions.com/).
## Project Support
We love PRs!
If cbpush makes you happy, please consider becoming a [Patreon supporter](https://www.patreon.com/ortussolutions).
## Resources
- Docmentation: https://cbpush.ortusbooks.com
- API Docs: https://apidocs.ortussolutions.com/#/coldbox-modules/cbpush/
- GitHub Repository: https://github.com/coldbox-modules/cbpush
- Issue Tracker: https://github.com/coldbox-modules/cbpush/issues