A simple socket.io-like Javascript front-end for Django Channels apps.
NodeJS' socket.io provides the simplest client-side API for developing websocket-based real-time applications. Django Channels provides a simple and powerful backend API for managing real-time communications that easily ties in with Django's ORM. This project aims to provide a socket.io-like Javascript API for simple real-time applications.
Simply add the following reference to your client-side HTML markup:
<script type="text/javascript" src="
https://raw.githubusercontent.com/k-pramod/channel.js/master/dist/channel.js"></script>Or clone this repo and use the latest files from the dist directory.
Check out this project's API and brief tutorial in the docs directory.
This project features a fully-worked, front-to-back example that illustrates how channel.js and Django Channels tie in together. Find the source code in the examples/chatter directory where brief setup instructions can also be found.
Features to be implemented in the near future include:
- More diverse examples with 'Deploy to Heroku' buttons
If you would like to propose new features, please use this repo's GitHub Issue tracker. If you would like to submit code to be included in future releases, please fork this repo and submit Pull Requests.