Skip to content

jails-org/Jails

Repository files navigation

Jails - A minimalistic Micro Framework

An Elegant and Minimalistic
Micro-Framework



🏝 Built for
Island Architecture
ƛ Inspired by
Elm Architecture
🔗 Ready for
hypermedia applications
NPM Jails Version MIT License



✍️ Abstract

The JavaScript ecosystem, including browsers and tools, has undergone significant evolution over the years. However, it's evident that many of the complexities introduced by frameworks today may not be essential for the majority of web applications. The prevailing trend in modern app development seems to prioritize expertise in frameworks over mastery of the language itself, often leading to a sense of being confined within the framework ecosystem.

Jails was designed to be:

🧩 Decoupled ⚡️ Lightweight 📦 Interoperable
Backend-agnostic, our solution seamlessly integrates with any backend framework or back-end programming language. Lightweight, just around 5kb when gzipped. It enhances your application's performance by progressively, separating HTML from your JavaScript code. It seamlessly integrates and functions alongside any other vanilla UI or behavioral libraries.


👩🏻‍💻 Usage

index.html

....

<app-counter>
  <template>
    <h1>{{count}}</h1>
    <button data-add>Add</button>
    <button data-subtract>Subtract</button>
  </template>
</app-counter>

<!-- or alternate version ( Considering SSR on page load ) -->
<app-counter>
  <h1 html-inner="count">0</h1>
  <button data-add>Add</button>
  <button data-subtract>Subtract</button>
</app-counter>

components/counter/index.ts

export default function appCounter({ main, on, state }) {

  main( _ => {
    on('click', '[data-add]', add)
    on('click', '[data-subtract]', subtract)
  })

  const add = () => {
    state.set( s => s.count+= 1 )
  }

  const subtract = () => {
    state.set( s => s.count-= 1 )
  }
}

export const model = {
  count: 0
}

main.ts

import { register, start } from 'jails-js'
import * as appCounter from './components/counter'

// Register all your components
register('app-counter', appCounter)

// Execute Jails
start()


🎥 Best Scenarios to use

Jails is better suited for:

Server Side Rendered ( SSR )

  • Wordpress
  • Laravel
  • Ruby on Rails
  • Node Backend with a Template System:
    • Pug, Liquid, Nunjucks, Handlebars etc.

Static Site Generated ( SSG )

  • Hugo
  • Astro
  • Jekill
  • 11ty ...etc

... Any site you can add a script tag on it =). So if you already have a engine that renders your html, Jails can be a good way to create an elegant event driven system.


📚 Demos & Docs


✋ Discussions

Join to the forum and be part of the project by asking, answering or discuss some aspect of the project and be welcome to help in your way.

Discussions


🎖 License

MIT

Packages

 
 
 

Contributors