Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jails-org/Jails
Elegant and Minimalistic Javascript Application Library
https://github.com/jails-org/Jails
custom-element hateoas island-architecture javascript javascript-applications javascript-library javascript-tools lightweight-javascript-library micro-frontend micro-frontends web-component web-components
Last synced: about 1 month ago
JSON representation
Elegant and Minimalistic Javascript Application Library
- Host: GitHub
- URL: https://github.com/jails-org/Jails
- Owner: jails-org
- License: mit
- Created: 2012-04-01T16:39:00.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2024-05-11T06:01:31.000Z (about 2 months ago)
- Last Synced: 2024-05-11T17:32:14.140Z (about 2 months ago)
- Topics: custom-element, hateoas, island-architecture, javascript, javascript-applications, javascript-library, javascript-tools, lightweight-javascript-library, micro-frontend, micro-frontends, web-component, web-components
- Language: TypeScript
- Homepage: https://jails-js.org
- Size: 1.94 MB
- Stars: 176
- Watchers: 16
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- awesome-stars - jails-org/Jails - Elegant and Minimalistic Javascript Application Library (TypeScript)
README
Jails
Elegant and Minimalistic
Javascript Application Library
Release Name: Athena
## ✍️ 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** - Backend-agnostic, our solution seamlessly integrates with any backend framework or programming language. It refrains from importing styles and ensures a clean demarcation by avoiding mixing HTML within the codebase.
- **Lightweight** - Lightweight, weighing in at just around 5kb when gzipped. It enhances your application's performance by progressively lightening the load, separating HTML from your JavaScript code. This practice results in smaller bundles and a more streamlined application.
- **Interoperable** - It seamlessly integrates and functions alongside any other vanilla UI or behavioral libraries. You no longer need to wait for a specific Jails Chart.js library to be available; simply integrate it into your application hassle-free.
## 👩🏻💻 Usage
`index.html`
```html
....
${count}
Add
Subtract
0
Add
Subtract
```
`components/counter/index.ts`
```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`
```ts
import jails from 'jails-js'
import * as appCounter from './components/counter'
// Register all your components
jails.register('app-counter', appCounter)
// Execute Jails
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
- [Online Examples & Playground](https://stackblitz.com/@Javiani/collections/jails-organization)
- [Documentation](https://jails-org.github.io/#/)
## ✋ 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](https://github.com/jails-org/Jails/discussions)
## 🎖 License
[MIT](http://opensource.org/licenses/MIT)