Warning
Deprecated. This template is superseded by
module-reference, which shows the same things (the data
Edrys.onUpdate delivers, sending and receiving messages) and adds sending to one user, listening to messages
from all modules, and a playground for the shared state API. It is plain files without a build step as well.
This template only gets critical fixes.
Switching: copy module-reference to start a new module, or
add https://edrys-labs.github.io/module-reference/ to a class to explore the module API.
This is a basic bare-bones Edrys Module, it is a good staring point for creating your own modules.
- Visit the Edrys Modules documentation for more infromation
- Click "Use this template" in the top right to get started
While Modules can be written in any combination of frontend technologies, we use and recommend the following:
- Alpine.js for UI (An alternative to JQuery, React or Vue)
- Water.css for styles (A tiny CSS reset with no classes)
- Open Iconic for icons
This combination results in lightweight, fast modules with very easy to read code that is largely free of framework boilerplate, and requires no build step. You also don't need to spend any time learning these frameworks as they are very easy to pick up.
Serve the module on localhost and add it to an Edrys class, then use any editor to modify the module. We recommend:
- VS Code Live Server which allows you to see your changes live as you make them
- VS Code Alpine.js Intellisense
To use the module, you need to serve it from somewhere and paste its link into your Edrys class settings. One convenient solution is GitHub Pages. Alternatives includes Netlify, GitLab pages, or placing the module in the Edrys static directory.
When releasing a module on GitHub, you can tag it with edrys and edrys-module to make it easy for others to find.