EquivalentJS
Class autoload and dependency manager
A JavaScript micro framework for modern web browsers to asynchronous autoload module classes and their dependencies handled by a manager for a dependency injection container.
Modules in this case are class definitions per file. All modules including all core modules of the framework self based on the same class interface, can be found in the generated documentation.
These modules represented by a constructor function as a class object. They can use dependency injection methods and listen to asynchronously autoloads by event or promise pattern.
They can switch on to use layout files from Sass generated or templates with Twig as a module class bound autoloaded resource.
Module classes are build in a namespace structure that can be used for everything what the power of JavaScript can do.
Initialization of module classes can be done via a HTML attribute or by another JavaScript that calls the module manager.
A module test runner based on QUnit and isolated test methods are available.
Also a documentation runner that based on JSDoc; view the doc tag interpretation in time at coding, with help of file watchers from Gulp.
This framework use jQuery to realize tasks in traversing, manipulation, events and ajax.
Content
- Module Manager(docs/MODULE_MANAGER.md)
- Module Plugin(docs/MODULE_PLUGIN.md)
- Test Runner(docs/TEST_RUNNER.md)
- Doc Runner(docs/DOC_RUNNER.md)
Requirements
Install dependencies with npmjs at project root folder
npm install
Documentation, scripts, stylesheets and templates
Generate scripts, stylesheets (Sass) and templates (Twig) and documentation (JSDoc & JSDoc Type)
npm run dev:run
or
npm run dev:watch
Run demo application in browser
npm run dev:http
http://127.0.0.1:8083/index.html
Build all EquivalentJS modules as concatenated minified library file
npm run prod:minify
http://127.0.0.1:8083/prod.html
How to contribute
Appendix
...live long and prosper