meinauto-js
v0.2.0
Published
Class autoload and dependency manager
Downloads
112
Readme
MeinAuto JS (MAJS)
Class autoload and dependency manager
Introduction
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 as a module class bound autoloaded stylesheet.
Module classes are build in a namespace struture 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.
Content
- Module Orchestration System(doc/tutorials/module/MODULE-ORCHESTRATION-SYSTEM.md)
- Module Test Runner(doc/tutorials/test/MODULE-TEST-RUNNER.md)
- Module Doc Runner(doc/tutorials/doc/MODULE-DOC-RUNNER.md)
Requirements
Install dependencies with npmjs at project root folder
npm install
Documentation, scripts and stylesheets
Generate scripts and stylesheets (Sass) and documentation (JSDoc & JSDoc Type)
npm run dev-run
or
npm run dev-watch
Run demo application in browser
e.g.
http://localhost/meinauto-js/web/index.html
or
http://localhost/meinauto-js/web/index.html?tests
or
http://localhost/meinauto-js/web/index.html?docs
Appendix
...live long and prosper