Documents : Developer Guide
How Did We Evolve?The architecture is a result of the learning extracted from various models of development. This can be defined as a solution to:-
- Common errors in patterns of development.
- Standard code guidelines that often go for a toss in timelines to delivery.
- Huge teams and Big Team of Developers that may cause regression issues in large projects.
It is a result of our past learning, observations and fruitful feedback that we have received for our work.
EJS is mostly used to include html partials, components, while the main HTML file remains with .html extension. The partials and components files contain .ejs claiming their inclusion nature
StaticFrame has two modes of accessing the site. One is production and another is development. While default mode is development(dev), production mode can be accessed in a page when its access via extra query ?prod=true . This allows to test your js and css files in minified version.
What All is Packaged?
HTMLA lot of coding best practices emphasize on keeping code lean and well organized. The goal is to write well-structured and standards-compliant markup. Static Frame will help to achieve modularity with the way we propose to organize your HTML code:-
- Story/ Module / Component based structuring.
- Defining global components that enable re-usability
- EJS – EJS combines data and a template to produce HTML. Here, our example data has a title and a list of supplies. EJS is much more than just providing markup template. You can explore more of EJS at http://www.embeddedjs.com/
CSSSMACSS – Scalable and Modular Architecture for CSS is an attempt to document a consistent approach to site development when using CSS. Here in Static Frame we have implemented this approach with the help of SCSS. Explore more on how SASS is used – http://sass-lang.com/
- Module + Reveal pattern – Easy to Understand, Debug, Track, and Fix.
- Pub-Sub Pattern for inter-component and inter-module communication – an easy way to globally communicate without attaching to any specific object.