https://github.com/8eecf0d2/jackle

🦊 Minimal and experimental redux-like web framework
https://github.com/8eecf0d2/jackle

framework hyperhtml lightweight minimal redux web

Last synced: 11 months ago
JSON representation

🦊 Minimal and experimental redux-like web framework

• Host: GitHub
• URL: https://github.com/8eecf0d2/jackle
• Owner: 8eecf0d2
• License: isc
• Created: 2018-07-20T05:49:29.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-12-04T14:57:31.000Z (about 7 years ago)
• Last Synced: 2025-03-02T12:01:46.831Z (12 months ago)
• Topics: framework, hyperhtml, lightweight, minimal, redux, web
• Language: TypeScript
• Homepage:
• Size: 75.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Jackle

[![Travis CI badge](https://travis-ci.org/8eecf0d2/jackle.svg?branch=master)](https://travis-ci.org/8eecf0d2/jackle)

[![Codeclimate maintainability](https://img.shields.io/codeclimate/maintainability-percentage/8eecf0d2/jackle.svg)](https://codeclimate.com/github/8eecf0d2/jackle)

[![Greenkeeper badge](https://badges.greenkeeper.io/8eecf0d2/jackle.svg)](https://greenkeeper.io/)

[![Bundlephobia minified badge](https://img.shields.io/bundlephobia/min/jackle.svg)](https://bundlephobia.com/result?p=jackle@latest)

[![Bundlephobia minified zipped badge](https://img.shields.io/bundlephobia/minzip/jackle.svg)](https://bundlephobia.com/result?p=jackle@latest)

Jackle is a tiny and _experimental_ framework for building `redux-like` web applications. It exposes a small API for managing components, state changes, routing and more!

## Getting Started

Install with yarn or npm​

```bash

yarn add jackle

```

Import and start using

```ts

import { Jackle } from 'jackle';

​

const jackle = new Jackle();

jackle.parser([...]);

jackle.handler([...]);

jackle.component([...]);

jackle.route([...]);

```

## API

Additional documentation and guides can be found in [the github wiki](https://github.com/8eecf0d2/jackle/wiki).

### Overview

In Jackle there are a few core modules, **Parser**, **Handler**, **Component**, all modules follow a simple `Object` structure and allow for a lot of flexiblity in regards to how they're composed.

I'm (8eecf0d2) currently learning about [Redux](https://redux.js.org/) and wanted to build a small framework similar to [Jagwah](https://github.com/8eecf0d2/jagwah) but with a more minimal approach and `redux-like` ideas. I'm _not completely sold_ on the immutable wave but it seems interesting enough to give it a crack.

If you get lost or are confused about how Jackle works it's _highly_ recommended to read the source, Jackle is _less than 200 lines_ of _verbose_ and _commented_ code.

### Documentation

All of the documentation is available in the [github wiki](https://github.com/8eecf0d2/jackle/wiki/Home/_edit).