kireji 0.0.7 → 0.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,16 @@
|
|
|
1
1
|
# Kireji - *Web Framework*
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
The Kireji Web Framework is a reactive full-stack web framework that uses the MPHF Coordinate System and the MVC paradigm to build multi-origin web app ecosystems. It offers a routing system that achieves the information-theoretic lower bound of data compression, enabling comprehensive deep linking, session bookmarking without user accounts or local storage, peer-to-peer data sharing without uploads or accounts, and cross-origin communication without cookies or CORS.
|
|
2
|
+
> **<sub>Part of the Kireji Project</sub>**<br><sup><i>omnia ex una linea</i></sup>
|
|
3
|
+
|
|
4
|
+
The **Kireji Web Framework** is a reactive full-stack web framework that uses the MPHF Coordinate System and the MVC paradigm to build multi-origin web app ecosystems. It offers a routing system that achieves the information-theoretic lower bound of data compression, enabling comprehensive deep linking, session bookmarking without user accounts or local storage, peer-to-peer data sharing without uploads or accounts, and cross-origin communication without cookies or CORS.
|
|
6
5
|
## The Kireji Project
|
|
7
|
-
The Kireji Project poses a question: **What if we could treat
|
|
6
|
+
The Kireji Project poses a question: **What if we could treat every web page as a point in a unified, mathematically mapped space?**
|
|
7
|
+
|
|
8
8
|
| Repo | Purpose
|
|
9
9
|
| ---- | -------
|
|
10
|
-
| [MPHF](https://github.com/kireji-app/mphf#readme) | [Coordinate System<br><
|
|
11
|
-
| **Kireji** | **Web Framework - ★ You are here<br><
|
|
12
|
-
| [Demo](https://github.com/kireji-app/demo#readme) | [App Ecosystem<br><
|
|
10
|
+
| [MPHF](https://github.com/kireji-app/mphf#readme) | [Coordinate System<br><sup>A bijective coordinate system for hashing structured data</sup>](https://github.com/kireji-app/mphf#readme)
|
|
11
|
+
| **Kireji** | **Web Framework - ★ You are here<br><sup>A reactive web framework with MPHF routing</sup>**
|
|
12
|
+
| [Demo](https://github.com/kireji-app/demo#readme) | [App Ecosystem<br><sup>An example app ecosystem demonstrating the project](https://github.com/kireji-app/demo#readme)</sup>
|
|
13
|
+
|
|
13
14
|
## Implementation
|
|
14
15
|
|
|
15
16
|
> <sub>Note: This is currently an empty placeholder for the framework that powers the [Demo App Ecosystem](https://github.com/kireji-app/demo#readme). Check back later to see if the package has been populated.</sub>
|
|
@@ -27,7 +28,7 @@ This refinement is designed to provide:
|
|
|
27
28
|
|
|
28
29
|
### Namespacing
|
|
29
30
|
|
|
30
|
-
Parts
|
|
31
|
+
Parts are assigned a unique namespace relating a web application's origin, for example:
|
|
31
32
|
|
|
32
33
|
```js
|
|
33
34
|
_.com.example
|
|
@@ -36,8 +37,12 @@ _.com.example.www.home
|
|
|
36
37
|
_.com.example.www.blog
|
|
37
38
|
```
|
|
38
39
|
|
|
39
|
-
###
|
|
40
|
-
|
|
40
|
+
### Built-in Parts
|
|
41
|
+
|
|
42
|
+
The framework's main part is the root part, a global object identified by `_`. This part is the root of the application component hierarchy, hosting both built-in and user-defined components.
|
|
43
|
+
|
|
44
|
+
#### Core Components
|
|
45
|
+
These parts are provided by the framework to act as MVC abstracts that handle MPHF arithmetic under the hood:
|
|
41
46
|
|
|
42
47
|
```js
|
|
43
48
|
_.parts.core.mix
|
|
@@ -46,8 +51,10 @@ _.parts.core.clip
|
|
|
46
51
|
...
|
|
47
52
|
```
|
|
48
53
|
|
|
49
|
-
|
|
54
|
+
#### Desktop Components
|
|
55
|
+
These parts are a collection of parts for bootstrapping, a Node.js server, server- and client-side rendering, a service worker and other functionality:
|
|
50
56
|
```js
|
|
57
|
+
_
|
|
51
58
|
_.parts.desktop.server
|
|
52
59
|
_.parts.desktop.client
|
|
53
60
|
_.parts.desktop.worker
|
|
@@ -60,7 +67,8 @@ _.parts.desktop.addressBar
|
|
|
60
67
|
The Kireji Web Framework does not import any third-party libraries, frameworks, or packages so that it can be reasoned about end-to-end as a self-contained and self-descriptive system.
|
|
61
68
|
|
|
62
69
|
## Status and License
|
|
63
|
-
The Kireji Web Framework is in **Alpha
|
|
70
|
+
The Kireji Web Framework is in **Alpha**.
|
|
71
|
+
|
|
64
72
|
The Kireji Project is in **early research and development**.
|
|
65
73
|
|
|
66
74
|
[](https://www.npmjs.com/kireji)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "kireji",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.8",
|
|
4
4
|
"description": "A web framework for stateful, entropy-perfect, multi-origin web applications. Currently in alpha. Expect breaking changes for version 0. Use with caution!",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./src/index.js",
|