kimu-core 0.4.1
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/.editorconfig +30 -0
- package/.gitattributes +11 -0
- package/.github/FUNDING.yml +8 -0
- package/.github/copilot-instructions.md +103 -0
- package/.github/kimu-copilot-instructions.md +3779 -0
- package/.github/workflows/deploy-demo.yml +39 -0
- package/AUTHORS.md +20 -0
- package/CHANGELOG.md +20 -0
- package/CODE_GUIDELINES.md +165 -0
- package/CODE_OF_CONDUCT.md +47 -0
- package/CONTRIBUTING.md +62 -0
- package/FUNDING.md +31 -0
- package/ISSUE_GUIDELINES.md +74 -0
- package/LICENSE +17 -0
- package/LICENSE.it.md +17 -0
- package/MPL-2.0.txt +373 -0
- package/NOTICE +65 -0
- package/README-KIMU.md +40 -0
- package/README.it.md +208 -0
- package/README.md +266 -0
- package/SECURITY.md +64 -0
- package/docs/get-started-en.md +207 -0
- package/docs/images/icon.svg +64 -0
- package/docs/images/logo_kimu.png +0 -0
- package/docs/index.md +29 -0
- package/env/dev.config.json +6 -0
- package/env/local.config.json +6 -0
- package/env/prod.config.json +6 -0
- package/env/staging.config.json +6 -0
- package/env/test.config.json +4 -0
- package/icon.svg +10 -0
- package/logo_kimu.png +0 -0
- package/package.json +79 -0
- package/public/favicon.svg +64 -0
- package/public/logo_kimu.svg +1 -0
- package/scripts/build-all-config.js +59 -0
- package/scripts/build-all-core.js +65 -0
- package/scripts/build-all-extensions.js +64 -0
- package/scripts/build-all-modules.js +99 -0
- package/scripts/build-extension.js +60 -0
- package/scripts/clear-kimu-build.js +31 -0
- package/scripts/generate-kimu-build-config.js +79 -0
- package/scripts/install-module.js +162 -0
- package/scripts/list-modules.js +109 -0
- package/scripts/minify-css-assets.js +82 -0
- package/scripts/remove-module.js +122 -0
- package/scripts/utils/fix-imports.js +85 -0
- package/src/assets/index.css +43 -0
- package/src/assets/kimu-style.css +84 -0
- package/src/assets/style.css +116 -0
- package/src/config/kimu-base-config.json +5 -0
- package/src/core/index.ts +47 -0
- package/src/core/kimu-app.ts +76 -0
- package/src/core/kimu-asset-manager.ts +167 -0
- package/src/core/kimu-component-element.ts +325 -0
- package/src/core/kimu-component.ts +33 -0
- package/src/core/kimu-engine.ts +188 -0
- package/src/core/kimu-extension-manager.ts +281 -0
- package/src/core/kimu-global-styles.ts +136 -0
- package/src/core/kimu-module-manager.ts +69 -0
- package/src/core/kimu-module.ts +21 -0
- package/src/core/kimu-path-config.ts +127 -0
- package/src/core/kimu-reactive.ts +196 -0
- package/src/core/kimu-render.ts +91 -0
- package/src/core/kimu-store.ts +147 -0
- package/src/core/kimu-types.ts +65 -0
- package/src/extensions/.gitkeep +0 -0
- package/src/extensions/extensions-manifest.json +13 -0
- package/src/extensions/kimu-home/component.ts +80 -0
- package/src/extensions/kimu-home/lang/en.json +5 -0
- package/src/extensions/kimu-home/lang/it.json +5 -0
- package/src/extensions/kimu-home/style.css +61 -0
- package/src/extensions/kimu-home/view.html +51 -0
- package/src/index.html +26 -0
- package/src/main.ts +68 -0
- package/src/modules/.gitkeep +0 -0
- package/src/modules/README.md +79 -0
- package/src/modules/i18n/README.it.md +63 -0
- package/src/modules/i18n/README.md +63 -0
- package/src/modules/i18n/kimu-global-lang.ts +26 -0
- package/src/modules/i18n/kimu-i18n-service.ts +108 -0
- package/src/modules/i18n/manifest.json +22 -0
- package/src/modules/i18n/module.ts +39 -0
- package/src/modules/modules-manifest.json +12 -0
- package/src/modules-repository/README.md +108 -0
- package/src/modules-repository/api-axios/CHANGELOG.md +48 -0
- package/src/modules-repository/api-axios/QUICK-REFERENCE.md +178 -0
- package/src/modules-repository/api-axios/README.md +304 -0
- package/src/modules-repository/api-axios/api-axios-service.ts +355 -0
- package/src/modules-repository/api-axios/examples.ts +293 -0
- package/src/modules-repository/api-axios/index.ts +19 -0
- package/src/modules-repository/api-axios/interfaces.ts +71 -0
- package/src/modules-repository/api-axios/module.ts +41 -0
- package/src/modules-repository/api-core/CHANGELOG.md +42 -0
- package/src/modules-repository/api-core/QUICK-REFERENCE.md +192 -0
- package/src/modules-repository/api-core/README.md +435 -0
- package/src/modules-repository/api-core/api-core-service.ts +289 -0
- package/src/modules-repository/api-core/examples.ts +432 -0
- package/src/modules-repository/api-core/index.ts +8 -0
- package/src/modules-repository/api-core/interfaces.ts +83 -0
- package/src/modules-repository/api-core/module.ts +30 -0
- package/src/modules-repository/event-bus/README.md +273 -0
- package/src/modules-repository/event-bus/event-bus-service.ts +176 -0
- package/src/modules-repository/event-bus/module.ts +30 -0
- package/src/modules-repository/i18n/README.it.md +63 -0
- package/src/modules-repository/i18n/README.md +63 -0
- package/src/modules-repository/i18n/kimu-global-lang.ts +26 -0
- package/src/modules-repository/i18n/kimu-i18n-service.ts +108 -0
- package/src/modules-repository/i18n/manifest.json +22 -0
- package/src/modules-repository/i18n/module.ts +39 -0
- package/src/modules-repository/notification/README.md +423 -0
- package/src/modules-repository/notification/module.ts +30 -0
- package/src/modules-repository/notification/notification-service.ts +436 -0
- package/src/modules-repository/router/README.it.md +39 -0
- package/src/modules-repository/router/README.md +39 -0
- package/src/modules-repository/router/manifest.json +21 -0
- package/src/modules-repository/router/module.ts +23 -0
- package/src/modules-repository/router/router.ts +144 -0
- package/src/modules-repository/state/README.md +409 -0
- package/src/modules-repository/state/module.ts +30 -0
- package/src/modules-repository/state/state-service.ts +296 -0
- package/src/modules-repository/theme/README.md +267 -0
- package/src/modules-repository/theme/module.ts +30 -0
- package/src/modules-repository/theme/pre-build.js +40 -0
- package/src/modules-repository/theme/theme-service.ts +389 -0
- package/src/modules-repository/theme/themes/theme-cherry-blossom.css +78 -0
- package/src/modules-repository/theme/themes/theme-cozy.css +111 -0
- package/src/modules-repository/theme/themes/theme-cyberpunk.css +150 -0
- package/src/modules-repository/theme/themes/theme-dark.css +79 -0
- package/src/modules-repository/theme/themes/theme-forest.css +171 -0
- package/src/modules-repository/theme/themes/theme-gold.css +100 -0
- package/src/modules-repository/theme/themes/theme-high-contrast.css +126 -0
- package/src/modules-repository/theme/themes/theme-lava.css +101 -0
- package/src/modules-repository/theme/themes/theme-lavender.css +90 -0
- package/src/modules-repository/theme/themes/theme-light.css +79 -0
- package/src/modules-repository/theme/themes/theme-matrix.css +103 -0
- package/src/modules-repository/theme/themes/theme-midnight.css +81 -0
- package/src/modules-repository/theme/themes/theme-nord.css +94 -0
- package/src/modules-repository/theme/themes/theme-ocean.css +84 -0
- package/src/modules-repository/theme/themes/theme-retro80s.css +343 -0
- package/src/modules-repository/theme/themes/theme-sunset.css +62 -0
- package/src/modules-repository/theme/themes-config.d.ts +27 -0
- package/src/modules-repository/theme/themes-config.json +213 -0
- package/src/vite-env.d.ts +1 -0
- package/tsconfig.json +33 -0
- package/vite.config.ts +99 -0
package/README.md
ADDED
|
@@ -0,0 +1,266 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://unicoverso.com/kimu" target="_blank">
|
|
3
|
+
<img src="logo_kimu.png" alt="KIMU Logo" width="180" />
|
|
4
|
+
</a>
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+

|
|
8
|
+

|
|
9
|
+

|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
# KIMU-CORE — The modular heart of KIMU
|
|
13
|
+
>**KIMU - Keep It Minimal UI Framework**
|
|
14
|
+
|
|
15
|
+
**KIMU-CORE** is the lightweight, modular runtime of [KIMU](https://github.com/unicoverso/kimu) framework: a web-native, ultra-minimal front-end framework built entirely on **Web Components**, designed for **poetic**, **extensible**, and **living** user interfaces.
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
# 🌐 Available Translations
|
|
22
|
+
|
|
23
|
+
- 🇬🇧 English – [README.md](./README.md)
|
|
24
|
+
- 🇮🇹 Italiano – [README.it.md](./README.it.md)
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
This package provides the **runtime engine** that powers the entire system, carefully crafted to be **small, elegant, and self-sufficient**.
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
> “Each extension is a thought. Each interface is a gesture.”
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
👉 This repository is the **heart of the KIMU framework**.
|
|
37
|
+
To discover the philosophy, documentation, examples, other extensions, modules, demos, and the playground, visit the main project:
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
> 🔗 **KIMU framework** : **[https://github.com/unicoverso/kimu](https://github.com/unicoverso/kimu)**
|
|
41
|
+
|
|
42
|
+
> 🔗 **KIMU-core** : **[https://github.com/unicoverso/kimu-core](https://github.com/unicoverso/kimu-core)**
|
|
43
|
+
|
|
44
|
+
> 🔗 **KIMU docs** : **[https://unicoverso.com/kimu/docs](https://unicoverso.com/kimu/docs)**
|
|
45
|
+
|
|
46
|
+
> 🔗 **KIMU-docs repository** : **[https://github.com/unicoverso/kimu-docs](https://github.com/unicoverso/kimu-docs)**
|
|
47
|
+
|
|
48
|
+
> 🔗 **KIMU webpage** : **[https://unicoverso.com/kimu](https://unicoverso.com/kimu)**
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
Created by [UnicòVerso](https://unicoverso.com) (Marco Di Pasquale, a.k.a. *Hocram*), to build lightweight, elegant, and responsive web interfaces.
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
# 🔧 What is `KIMU-CORE`?
|
|
58
|
+
|
|
59
|
+
`KIMU-CORE` is the **technical core** that starts, loads, and orchestrates extensions in the [KIMU](https://github.com/UnicoVerso/kimu) ecosystem.
|
|
60
|
+
|
|
61
|
+
> "Minimal doesn't mean limited. It means intentional."
|
|
62
|
+
|
|
63
|
+
It includes everything needed to:
|
|
64
|
+
|
|
65
|
+
- 🧠 Register and manage modular extensions
|
|
66
|
+
- 🧩 Dynamically load HTML, JS, and CSS components
|
|
67
|
+
- 🖇️ Connect UI elements via events, shared context, and scoped styles
|
|
68
|
+
- 💾 Handle shared local state and memory caching
|
|
69
|
+
- 🧱 Support **declarative UI building** using only Web Components
|
|
70
|
+
|
|
71
|
+
No bundlers. No virtual DOM. No dependencies. Just modern **vanilla JavaScript**, intentionally designed.
|
|
72
|
+
|
|
73
|
+
> It’s the perfect foundation for modular ecosystems, creative interfaces, low-footprint apps, or poetic digital experiences.
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
# 🌱 What is KIMU?
|
|
80
|
+
|
|
81
|
+
**KIMU** is a lightweight, modular, and flexible front-end framework designed to create elegant and efficient user interfaces with minimal effort and overhead.
|
|
82
|
+
|
|
83
|
+
Built on native **web standards**, with no external dependencies,
|
|
84
|
+
`KIMU` embraces **declarative** and **modular** design.
|
|
85
|
+
|
|
86
|
+
> _“Each extension is a thought. Each interface is a gesture.”_
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
## ⚙️ KIMU - Key Features
|
|
93
|
+
|
|
94
|
+
- 🌿 **Ultra-lightweight architecture** - Minimal code and optimized performance from the very first byte
|
|
95
|
+
- 📦 **Modular components** - with zero overhead and no forced dependencies
|
|
96
|
+
- ✅ **Build Zero dependencies** – build in pure JS, ready to use, no external libraries
|
|
97
|
+
- 🔌 **Dynamic extension system** – extension independent, self-loading HTML+JS+CSS modules
|
|
98
|
+
- 🧩 **Radical modularity** – every part can be replaced or disabled
|
|
99
|
+
- ⚡ **Instant startup** – no heavy initialization process
|
|
100
|
+
- 🌐 **Web-native** – built entirely on browser standards (Web Components, Custom Elements)
|
|
101
|
+
- 🧱 **Declarative components** – apps are built as a sum of extensions, no third-party framework needed
|
|
102
|
+
- 🎯 **Composition-first** – apps are built from isolated, flexible modules
|
|
103
|
+
- 🚀 **Clean, Minimal UI and Focused Web Experiences** - Designed focused web applications, digital kiosks, dashboards and clean web interfaces
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
## ❓ Why Choose KIMU
|
|
110
|
+
|
|
111
|
+
KIMU is designed for creators who want to build **clean, minimal, and adaptive web interfaces** — without unnecessary complexity.
|
|
112
|
+
Whether you're crafting a light frontend, a kiosk, a dashboard, or a modular application, `KIMU-CORE` gives you a focused foundation to build on.
|
|
113
|
+
|
|
114
|
+
- 🚀 A **frontend framework** that stays out of your way and supports your creative flow
|
|
115
|
+
- 🖥️ Create **ultralight dashboards**, **kiosk interfaces**, or **embedded UIs**
|
|
116
|
+
- 🧩 Build **self‑contained applications** with dynamically loaded extensions
|
|
117
|
+
- 🎛️ Prototype **modular, interactive experiences** — ideal for exhibitions, museums, or educational tools
|
|
118
|
+
- 🧠 Orchestrate **self‑configuring extensions** via manifest files and metadata
|
|
119
|
+
- 🧬 Build **customizable digital environments** with thematic digital environments
|
|
120
|
+
- 🌿 Embrace a philosophy where **performance and simplicity** matter more than feature‑bloat
|
|
121
|
+
- 🎨 Build digital spaces that feel **personalized, poetic, and purposeful**
|
|
122
|
+
|
|
123
|
+
> A solid foundation for creative tools, low‑footprint apps, and modular ecosystems.
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
## 🌿 Philosophy
|
|
130
|
+
|
|
131
|
+
> "Minimal doesn't mean lacking.
|
|
132
|
+
> It means focusing on what truly matters."
|
|
133
|
+
|
|
134
|
+
KIMU encourages a design and development approach where every element has a reason to exist.
|
|
135
|
+
No bloat, no unnecessary complexity — just pure functionality, elegantly presented.
|
|
136
|
+
|
|
137
|
+
KIMU follows the principle of essentialism:
|
|
138
|
+
- Every element exists because it has meaning.
|
|
139
|
+
- Every interaction is designed for clarity.
|
|
140
|
+
- Complexity is embraced only when it serves the user.
|
|
141
|
+
|
|
142
|
+
> "No bloat.
|
|
143
|
+
> No distractions.
|
|
144
|
+
> Pure, meaningful interfaces."
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
## 🚀 Getting started
|
|
151
|
+
|
|
152
|
+
👉 `KIMU-CORE` will soon be published on npm.
|
|
153
|
+
In the meantime, you can clone this repository or include its JS files directly in your project.
|
|
154
|
+
|
|
155
|
+
Documentation and examples will be available at:
|
|
156
|
+
|
|
157
|
+
> 🔗 **KIMU get started** : [Get Started](./docs/index.md)
|
|
158
|
+
|
|
159
|
+
> 🔗 **KIMU docs online** : [https://unicoverso.com/kimu/docs](https://unicoverso.com/kimu/docs)
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
## 📦 License
|
|
166
|
+
|
|
167
|
+
All non-executable content of the `KIMU` project
|
|
168
|
+
(documentation, philosophy, structure) is licensed under
|
|
169
|
+
[Creative Commons Attribution 4.0 International](./LICENSE) (CC BY 4.0).
|
|
170
|
+
|
|
171
|
+
You are free to use, modify, and redistribute the code, respecting the terms of this license, as long as changes to MPL-covered files remain public under the same license.
|
|
172
|
+
|
|
173
|
+
For additional information on attribution, contributions, and naming, please refer to the [NOTICE file](./NOTICE).
|
|
174
|
+
|
|
175
|
+
See the [`LICENSE`](./LICENSE) file for full details.
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
## 🏷️ Naming and Attribution
|
|
182
|
+
|
|
183
|
+
"KIMU", "KIMU-CORE" and "UnicòVerso" are part of a creative ecosystem led by the original author.
|
|
184
|
+
Please refer to the [`NOTICE`](./NOTICE) for appropriate use of names and trademarks.
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
---
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
## 🤝 Contributions
|
|
191
|
+
|
|
192
|
+
We welcome feedback, ideas, and contributions of any kind.
|
|
193
|
+
Bug fixes, new extensions, or even thoughtful suggestions help `KIMU` grow.
|
|
194
|
+
|
|
195
|
+
By contributing, you accept the terms outlined in the [`NOTICE`](./NOTICE) and [`CONTRIBUTING.md`](./CONTRIBUTING.md).
|
|
196
|
+
Your contributions will always be acknowledged and respected.
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
## 💌 Share your thoughts
|
|
203
|
+
|
|
204
|
+
`KIMU` framework is a project born from passion, grown with care, and carried forward with the passion to build something light, human and useful.
|
|
205
|
+
|
|
206
|
+
If you've used it, explored it, or even just glanced at it — say something.
|
|
207
|
+
A thought, a suggestion, a kind word, or a simple “hello”.
|
|
208
|
+
|
|
209
|
+
Every message is a beam of light.
|
|
210
|
+
Every word might spark a new extension.
|
|
211
|
+
Every gesture helps fuel this journey.
|
|
212
|
+
|
|
213
|
+
📬 Send me a message, even just to say *"I see you. Keep going."*
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
---
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
## 🧑💻 Author and Contact
|
|
220
|
+
|
|
221
|
+
Created and maintained by:
|
|
222
|
+
**Marco Di Pasquale** *(aka Hocram)*
|
|
223
|
+
on behalf of the collective **[UnicòVerso](https://unicoverso.com)**
|
|
224
|
+
|
|
225
|
+
- 🌍 Website: [https://unicoverso.com/kimu](https://unicoverso.com/kimu)
|
|
226
|
+
- 🐙 GitHub: [https://github.com/unicoverso/kimu-core](https://github.com/unicoverso/kimu-core)
|
|
227
|
+
- 🚀 Framework Reference: [https://github.com/unicoverso/kimu](https://github.com/unicoverso/kimu)
|
|
228
|
+
- 📩 Email: [info@unicoverso.com](mailto:info@unicoverso.com)
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
---
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
## 💖 Support / Donate
|
|
235
|
+
|
|
236
|
+
🇬🇧 **Want to support KIMU-Core?**
|
|
237
|
+
Find all donation and support options in the [FUNDING.md](./FUNDING.md) file.
|
|
238
|
+
|
|
239
|
+
You can contribute via:
|
|
240
|
+
- [GitHub Sponsors](https://github.com/sponsors/hocram)
|
|
241
|
+
- [OpenCollective](https://opencollective.com/unicoverso)
|
|
242
|
+
- [Patreon](https://www.patreon.com/UnicoVerso)
|
|
243
|
+
- [Ko-fi](https://ko-fi.com/marcodipasquale)
|
|
244
|
+
- [PayPal](https://paypal.me/marcodipasquale)
|
|
245
|
+
- [BuyMeACoffee](https://www.buymeacoffee.com/hocram)
|
|
246
|
+
- [unicoverso.com/dona](https://unicoverso.com/dona)
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
---
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
<p align="center">
|
|
253
|
+
<a href="https://unicoverso.com/kimu" target="_blank">
|
|
254
|
+
<img src="icon.svg" alt="KIMU Logo" width="120" />
|
|
255
|
+
</a>
|
|
256
|
+
</p>
|
|
257
|
+
|
|
258
|
+
> _“KIMU is not just a framework.
|
|
259
|
+
> It’s a way to slow down,
|
|
260
|
+
> to listen to what matters,
|
|
261
|
+
> and to build with purpose. 🌱”_
|
|
262
|
+
|
|
263
|
+
<p>
|
|
264
|
+
<img src="icon.svg" alt="KIMU Icon" width="24" style="vertical-align: middle; margin-right: 8px;" />
|
|
265
|
+
Happy coding. Play, create, stay light. Welcome to `KIMU`!
|
|
266
|
+
</p>
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# 🔐 Security Policy for KIMU
|
|
2
|
+
|
|
3
|
+
Thank you for helping keep **KIMU** safe.
|
|
4
|
+
|
|
5
|
+
## 🛡️ Reporting Security Issues
|
|
6
|
+
|
|
7
|
+
If you find a security vulnerability in the KIMU framework, please report it responsibly.
|
|
8
|
+
**Do not open a public issue.**
|
|
9
|
+
|
|
10
|
+
Do not disclose security vulnerabilities publicly without giving us the opportunity to investigate and address the issue.
|
|
11
|
+
|
|
12
|
+
To report a vulnerability, contact:
|
|
13
|
+
|
|
14
|
+
**Marco Di Pasquale (UnicòVerso)**
|
|
15
|
+
📧 Email: [info@unicoverso.com](mailto:info@unicoverso.com)
|
|
16
|
+
|
|
17
|
+
Please include as much detail as possible, such as:
|
|
18
|
+
|
|
19
|
+
- A clear and concise description of the issue
|
|
20
|
+
- Steps to reproduce the vulnerability
|
|
21
|
+
- Any potential impact or severity assessment
|
|
22
|
+
|
|
23
|
+
We aim to respond to security reports within **5 business days** and will work with you to address the issue promptly and respectfully.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## 📝 Supported Versions
|
|
28
|
+
|
|
29
|
+
We actively maintain and provide security updates for:
|
|
30
|
+
|
|
31
|
+
- The latest **major version** of KIMU
|
|
32
|
+
- Minor versions that are currently under active development
|
|
33
|
+
|
|
34
|
+
Older versions may not receive security patches unless explicitly stated.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## 🤝 Responsible Disclosure
|
|
39
|
+
|
|
40
|
+
We appreciate responsible disclosure and will credit contributors who report valid vulnerabilities (unless anonymity is requested).
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## ✅ Best Practices for Developers
|
|
45
|
+
|
|
46
|
+
While we strive to build secure software, we encourage all developers using KIMU to:
|
|
47
|
+
|
|
48
|
+
- Keep dependencies up to date
|
|
49
|
+
- Follow secure coding practices
|
|
50
|
+
- Validate user input and sanitize all data
|
|
51
|
+
- Avoid exposing sensitive information
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## 🙏 Thank You
|
|
56
|
+
|
|
57
|
+
Your efforts to improve KIMU’s security are greatly appreciated.
|
|
58
|
+
Thank you for your responsibility and cooperation.
|
|
59
|
+
Together, we can build a safer and more reliable framework.
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
For questions or concerns, visit the project:
|
|
64
|
+
🔗 [https://github.com/unicoverso/kimu](https://github.com/unicoverso/kimu)
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://unicoverso.com/kimu" target="_blank">
|
|
3
|
+
<img src="images/logo_kimu.png" alt="KIMU Logo" width="180" />
|
|
4
|
+
</a>
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
# 🚀 Get Started with KIMU Core
|
|
8
|
+
|
|
9
|
+
Welcome to **KIMU – Keep It Minimal UI Framework**!
|
|
10
|
+
|
|
11
|
+
This guide will walk you through the basic steps to download, install, and run the core-framework for the first time.
|
|
12
|
+
|
|
13
|
+
## 🔧 Prerequisites
|
|
14
|
+
|
|
15
|
+
Before you start, make sure the following tools are installed on your system:
|
|
16
|
+
|
|
17
|
+
- [**Git**](https://git-scm.com/) – to clone the repository and manage code versions
|
|
18
|
+
Recommended: version ≥ 2.30
|
|
19
|
+
|
|
20
|
+
- [**Node.js**](https://nodejs.org/) – to install and run the project dependencies
|
|
21
|
+
Recommended: **LTS version** (≥ 18.x)
|
|
22
|
+
This also includes `npm`, the Node.js package manager
|
|
23
|
+
|
|
24
|
+
- [**TypeScript**](https://www.typescriptlang.org/) – required for compiling `.ts` files
|
|
25
|
+
Install localy with:
|
|
26
|
+
```bash
|
|
27
|
+
npm install --save-dev typescript
|
|
28
|
+
```
|
|
29
|
+
Or install globally with:
|
|
30
|
+
```bash
|
|
31
|
+
npm install -g typescript
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
- (Optional) [**Python 3.x**](https://www.python.org/downloads/) – used in `py-server` script to start a quick static server for distribution files:
|
|
35
|
+
```bash
|
|
36
|
+
python3 -m http.server 5173 --directory ./dist
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
💡 You can verify the installation by running:
|
|
40
|
+
> ```bash
|
|
41
|
+
> node -v
|
|
42
|
+
> npm -v
|
|
43
|
+
> git --version
|
|
44
|
+
> ```
|
|
45
|
+
|
|
46
|
+
If any of these commands fails, please install the corresponding tool from the links above before continuing.
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
## 📦 1. Clone the Repository
|
|
50
|
+
|
|
51
|
+
Use Git to clone the project from the official GitHub repository:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
git clone https://github.com/unicoverso/kimu-core.git
|
|
55
|
+
cd kimu-core
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
## 📥 2. Install Dependencies
|
|
60
|
+
|
|
61
|
+
Install all necessary dependencies using `npm`:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npm install
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
## 🏗️ 3. Build the Project
|
|
69
|
+
|
|
70
|
+
To generate the full distribution build (TypeScript compilation + configuration + Vite + extensions):
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
npm run build
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
This command performs:
|
|
77
|
+
|
|
78
|
+
- TypeScript compilation
|
|
79
|
+
- Configuration generation (for `dev` by default)
|
|
80
|
+
- Vite bundling
|
|
81
|
+
- Dynamic extension building
|
|
82
|
+
|
|
83
|
+
You can also run the build with a specific environment:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
npm run build:dev # Development (default)
|
|
87
|
+
npm run build:local # Local development
|
|
88
|
+
npm run build:prod # Production
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## ⚙️ 4. (Optional) Advanced Configuration Scripts
|
|
92
|
+
|
|
93
|
+
If you want to generate the configuration manually without building, you can run:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
npm run generate-config # Default (development)
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Other environment variants:
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
npm run generate-config:dev # Development
|
|
103
|
+
npm run generate-config:local # Local
|
|
104
|
+
npm run generate-config:test # Test
|
|
105
|
+
npm run generate-config:prod # Production
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
## 🧹 5. (Optional) Clear Previous Builds
|
|
110
|
+
|
|
111
|
+
To clean up previous build files:
|
|
112
|
+
|
|
113
|
+
```bash
|
|
114
|
+
npm run clear:build
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
## 🔧 6. Build All Extensions Only
|
|
119
|
+
|
|
120
|
+
To build all extensions dynamically and prepare them for runtime:
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
npm run build:all-ext
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
## 🌐 7. Run the Local Development Server
|
|
128
|
+
|
|
129
|
+
To preview the Hello App locally and start developing:
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
npm start
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Then open your browser and visit:
|
|
136
|
+
|
|
137
|
+
```
|
|
138
|
+
http://localhost:5173/
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
You should see the **Hello App** running!
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
## 📁 8. Output Location
|
|
145
|
+
|
|
146
|
+
After the build process, all compiled files are available in the `dist/` directory.
|
|
147
|
+
This includes:
|
|
148
|
+
- Pure JS files (no bundler required)
|
|
149
|
+
- HTML, CSS and assets
|
|
150
|
+
- Extension files and manifest
|
|
151
|
+
|
|
152
|
+
These are ready to be served as static files or integrated into your own system.
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## ✅ What’s Next?
|
|
157
|
+
|
|
158
|
+
You can now explore:
|
|
159
|
+
- How to create your own extension
|
|
160
|
+
- How to use the KIMU runtime API
|
|
161
|
+
- How to customize the experience
|
|
162
|
+
|
|
163
|
+
See the full documentation in `docs/` for more.
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
## 📖 Available Documentation
|
|
168
|
+
|
|
169
|
+
- [📚 KIMU Online docs](https://unicoverso.com/kimu/docs) – Learn how to use the framework
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
## 💌 Share your thoughts
|
|
174
|
+
|
|
175
|
+
KIMU is a project built with care, shaped by intention, and carried forward with passion.
|
|
176
|
+
|
|
177
|
+
If you've used it, explored it, or even just glanced at it — say something.
|
|
178
|
+
A thought, a suggestion, a kind word, or a simple “hello”.
|
|
179
|
+
|
|
180
|
+
Every message is a beam of light.
|
|
181
|
+
Every word might spark a new extension.
|
|
182
|
+
Every gesture helps fuel this journey.
|
|
183
|
+
|
|
184
|
+
📬 Send me a message, even just to say *"I see you. Keep going."*
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
## 🧑💻 Author and Contact
|
|
189
|
+
|
|
190
|
+
Created and maintained by:
|
|
191
|
+
**Marco Di Pasquale** *(aka Hocram)*
|
|
192
|
+
on behalf of the collective **[UnicòVerso](https://unicoverso.com)**
|
|
193
|
+
|
|
194
|
+
- 🌍 Website: [https://unicoverso.com/kimu](https://unicoverso.com/kimu)
|
|
195
|
+
|
|
196
|
+
- 🐙 GitHub: [https://github.com/unicoverso/kimu-core](https://github.com/unicoverso/kimu-core)
|
|
197
|
+
|
|
198
|
+
- 🚀 Framework Reference: [https://github.com/unicoverso/kimu](https://github.com/unicoverso/kimu)
|
|
199
|
+
|
|
200
|
+
- 📩 Email: [info@unicoverso.com](mailto:info@unicoverso.com)
|
|
201
|
+
|
|
202
|
+
---
|
|
203
|
+
|
|
204
|
+
<p>
|
|
205
|
+
<img src="images/icon.svg" alt="KIMU Icon" width="24" style="vertical-align: middle; margin-right: 8px;" />
|
|
206
|
+
Happy coding. Play, create, stay light. Welcome to KIMU!
|
|
207
|
+
</p>
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
|
2
|
+
<svg
|
|
3
|
+
id="Livello_2"
|
|
4
|
+
viewBox="0 0 128 128"
|
|
5
|
+
version="1.1"
|
|
6
|
+
sodipodi:docname="kimu-icon-128x128.svg"
|
|
7
|
+
width="128"
|
|
8
|
+
height="128"
|
|
9
|
+
inkscape:version="1.4 (e7c3feb1, 2024-10-09)"
|
|
10
|
+
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
|
11
|
+
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
|
12
|
+
xmlns="http://www.w3.org/2000/svg"
|
|
13
|
+
xmlns:svg="http://www.w3.org/2000/svg">
|
|
14
|
+
<sodipodi:namedview
|
|
15
|
+
id="namedview4"
|
|
16
|
+
pagecolor="#ffffff"
|
|
17
|
+
bordercolor="#000000"
|
|
18
|
+
borderopacity="0.25"
|
|
19
|
+
inkscape:showpageshadow="2"
|
|
20
|
+
inkscape:pageopacity="0.0"
|
|
21
|
+
inkscape:pagecheckerboard="0"
|
|
22
|
+
inkscape:deskcolor="#d1d1d1"
|
|
23
|
+
inkscape:zoom="1.5142353"
|
|
24
|
+
inkscape:cx="124.15507"
|
|
25
|
+
inkscape:cy="86.182112"
|
|
26
|
+
inkscape:window-width="1440"
|
|
27
|
+
inkscape:window-height="872"
|
|
28
|
+
inkscape:window-x="0"
|
|
29
|
+
inkscape:window-y="28"
|
|
30
|
+
inkscape:window-maximized="0"
|
|
31
|
+
inkscape:current-layer="Livello_2" />
|
|
32
|
+
<defs
|
|
33
|
+
id="defs1">
|
|
34
|
+
<style
|
|
35
|
+
id="style1">.cls-1{fill:#f45e32;}.cls-2{fill:#fff463;}.cls-3{fill:#88d1e2;}.cls-4{fill:#91d292;}</style>
|
|
36
|
+
</defs>
|
|
37
|
+
<g
|
|
38
|
+
id="g4"
|
|
39
|
+
transform="translate(0,-0.83295207)">
|
|
40
|
+
<g
|
|
41
|
+
id="Girandola"
|
|
42
|
+
transform="matrix(0.91533181,0,0,0.91533181,-1.552e-7,14)">
|
|
43
|
+
<g
|
|
44
|
+
id="Aste">
|
|
45
|
+
<path
|
|
46
|
+
class="cls-3"
|
|
47
|
+
d="m 57.47,111.07 c 18.74,0 33.94,-15.19 33.94,-33.94 0,-9.65 -4.03,-18.36 -10.49,-24.54 L 47.95,109.7 c 3.02,0.88 6.22,1.36 9.53,1.36 z"
|
|
48
|
+
id="path1" />
|
|
49
|
+
<path
|
|
50
|
+
class="cls-1"
|
|
51
|
+
d="M 82.48,0 C 63.74,0 48.54,15.19 48.54,33.94 c 0,9.65 4.03,18.36 10.49,24.54 L 92.01,1.36 C 88.99,0.48 85.79,0 82.48,0 Z"
|
|
52
|
+
id="path2" />
|
|
53
|
+
<path
|
|
54
|
+
class="cls-2"
|
|
55
|
+
d="m 3.59,71.31 c 9.37,16.23 30.13,21.79 46.36,12.42 8.36,-4.82 13.88,-12.67 16,-21.36 H 0 c 0.75,3.06 1.93,6.07 3.59,8.94 z"
|
|
56
|
+
id="path3" />
|
|
57
|
+
<path
|
|
58
|
+
class="cls-4"
|
|
59
|
+
d="M 136.25,39.58 C 126.88,23.35 106.12,17.79 89.89,27.16 c -8.36,4.82 -13.88,12.67 -16,21.36 h 65.95 c -0.75,-3.06 -1.93,-6.07 -3.59,-8.94 z"
|
|
60
|
+
id="path4" />
|
|
61
|
+
</g>
|
|
62
|
+
</g>
|
|
63
|
+
</g>
|
|
64
|
+
</svg>
|
|
Binary file
|
package/docs/index.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# 📚 KIMU Documentation Index
|
|
2
|
+
|
|
3
|
+
Welcome to the official documentation for **KIMU** framework — *Keep It Minimal UI Framework*.
|
|
4
|
+
|
|
5
|
+
This space is dedicated to help you understand, install, and build with the `kimu-core` runtime and the broader KIMU ecosystem.
|
|
6
|
+
|
|
7
|
+
> "Minimal doesn't mean limited. It means intentional."
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
## 💡 About KIMU
|
|
11
|
+
|
|
12
|
+
KIMU is a minimal, web-native, modular framework built entirely on **Web Components**. It is designed for:
|
|
13
|
+
|
|
14
|
+
* Building lightweight digital experiences
|
|
15
|
+
* Creating poetic and expressive interfaces
|
|
16
|
+
* Deploying fast, dependency-free applications
|
|
17
|
+
|
|
18
|
+
Whether you're crafting a dashboard, a kiosk interface, or a creative digital project — KIMU keeps your front-end clean, clear, and powerful.
|
|
19
|
+
|
|
20
|
+
> “Each extension is a thought. Each interface is a gesture.”
|
|
21
|
+
|
|
22
|
+
Created by [UnicòVerso](https://unicoverso.com)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## 📖 Available Documentation
|
|
26
|
+
|
|
27
|
+
- [🌱 Get Started (EN)](get-started.md) – Learn how start to install and run the core framework
|
|
28
|
+
|
|
29
|
+
- [📚 Online docs](https://unicoverso.com/kimu/docs) – Learn how to use the framework
|
package/icon.svg
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
<svg viewBox="0 0 128 128" xmlns="http://www.w3.org/2000/svg">
|
|
2
|
+
<g transform="translate(0,-0.83295207)">
|
|
3
|
+
<g transform="matrix(0.91533181,0,0,0.91533181,0,14)">
|
|
4
|
+
<path fill="#88d1e2" d="M57.47 111.07c18.74 0 33.94-15.19 33.94-33.94 0-9.65-4.03-18.36-10.49-24.54L47.95 109.7c3.02.88 6.22 1.36 9.53 1.36z"/>
|
|
5
|
+
<path fill="#f45e32" d="M82.48 0C63.74 0 48.54 15.19 48.54 33.94c0 9.65 4.03 18.36 10.49 24.54L92.01 1.36C88.99.48 85.79 0 82.48 0z"/>
|
|
6
|
+
<path fill="#fff463" d="M3.59 71.31c9.37 16.23 30.13 21.79 46.36 12.42 8.36-4.82 13.88-12.67 16-21.36H0c.75 3.06 1.93 6.07 3.59 8.94z"/>
|
|
7
|
+
<path fill="#91d292" d="M136.25 39.58c-9.37-16.23-30.13-21.79-46.36-12.42-8.36 4.82-13.88 12.67-16 21.36h65.95c-.75-3.06-1.93-6.07-3.59-8.94z"/>
|
|
8
|
+
</g>
|
|
9
|
+
</g>
|
|
10
|
+
</svg>
|
package/logo_kimu.png
ADDED
|
Binary file
|