Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unyt-org/uix
The UIX Framework
https://github.com/unyt-org/uix
deno framework fullstack javascript typescript uix unyt web
Last synced: about 1 month ago
JSON representation
The UIX Framework
- Host: GitHub
- URL: https://github.com/unyt-org/uix
- Owner: unyt-org
- License: mit
- Created: 2023-04-13T15:37:50.000Z (over 1 year ago)
- Default Branch: uix-new
- Last Pushed: 2024-08-04T22:41:44.000Z (about 2 months ago)
- Last Synced: 2024-08-05T00:19:21.892Z (about 2 months ago)
- Topics: deno, framework, fullstack, javascript, typescript, uix, unyt, web
- Language: TypeScript
- Homepage: https://uix.unyt.org
- Size: 78.4 MB
- Stars: 52
- Watchers: 2
- Forks: 3
- Open Issues: 60
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[uix.unyt.org](https://uix.unyt.org) • a unyt.org project
--------------------------
## What is UIX?
UIX is an open-source full-stack framework for developing reactive web apps with *restorable and shared state*.
UIX runs on a [deno](https://docs.deno.com/runtime/manual) backend and
supports both *single- and multi page* applications
with frontend or server-side rendering and hydration.
The [DATEX JavaScript Library](https://docs.unyt.org/manual/datex/introduction) acts as the backbone of UIX, providing useful functionality such as *reactivity and cross-device data exchange*.
In contrast to frameworks like React, UIX provides *direct wiring* to the DOM for reactivity and does not need a virtual DOM.
There are many ways to create UIX applications:
* using the **TypeScript UIX Library** and JSX (focus of the documentation)
* defining UIX states with **DATEX**
* using the **UIX Web Editor** (still in development)
The UIX library is designed with a modular approach that makes it easy for developers to add custom components and logic as needed.
**Main features**
* [Cross-network reactivity](./docs/manual/02%20Cross-Realm%20Imports.md#Reactivity)
* [Server side rendering with partial hydration](./docs/manual/08%20Rendering%20Methods.md)
* [Hybrid backend/frontend routing](./docs/manual/05%20Entrypoints%20and%20Routing.md)
* [Cross-realm imports](./docs/manual/02%20Cross-Realm%20Imports.md)
* [Shared memory](./docs/manual/02%20Cross-Realm%20Imports.md#Synchronization)
* [JSX support](./docs/manual/03%20JSX.md)
* [Reusable web components](./docs/manual/04%20Components.md)
* [And many more](https://uix.unyt.org)...
UIX aims to simplify all phases of the app development cycle, including design, development, testing and distribution, in order to make the developer experience as convenient as possible.
This is why UIX ships with integrated features such as:
* Hot reloading
* [Testing library](https://github.com/unyt-org/unyt-tests/)
* [Stage management](./docs/manual/09%20Configuration.md#app-deployment-stages)
* Version management
* [Automated deployment](./docs/manual/15%20Deployment.md)
## Documentation
> [!NOTE]
> You can find all [UIX](https://uix.unyt.org) documentation and resources on [docs.unyt.org](https://docs.unyt.org).
> Please be aware that the documentation is work in progress and may change in the future.
1. [Getting Started](./docs/manual/01%20Getting%20Started.md)
2. [Imports](./docs/manual/02%20Cross-Realm%20Imports.md)
3. [JSX](./docs/manual/03%20JSX.md)
4. [Components](./docs/manual/04%20Components.md)
5. [Entrypoints and Routing](./docs/manual/05%20Entrypoints%20and%20Routing.md)
6. [Component States](./docs/manual/06%20Component%20States.md)
7. [Persistent Contexts](./docs/manual/07%20Persistent%20Contexts.md)
8. [Rendering Methods](./docs/manual/08%20Rendering%20Methods.md)
9. [Configuration](./docs/manual/09%20Configuration.md)
10. [Localization](./docs/manual/10%20Localization.md)
11. [Functions and Contexts](./docs/manual/11%20Functions%20and%20Contexts.md)
12. [Styles and Themes](./docs/manual/12%20Styles%20and%20Themes.md)
13. [Shadow DOM](./docs/manual/13%20Shadow%20DOM.md)
14. [Utility Functions](./docs/manual/14%20Utility%20Functions.md)
15. [Deployment](./docs/manual/15%20Deployment.md)
16. [HTTP Tunneling](./docs/manual/16%20HTTP%20Tunneling.md)
17. [Plugins](./docs/manual/17%20Plugins.md)
18. [Guide](./docs/manual/18%20Guide.md)
19. [Rendering](./docs/manual/19%20Rendering.md)
20. [App Communication](./docs/manual/20%20App%20Communication.md)
## Examples
Feel free to browse a collection of UIX projects on [uix.unyt.org/templates](https://uix.unyt.org/templates).
* [UIX Base Project](https://github.com/unyt-org/uix-base-project)
* [UIX Base Project + Routing](https://github.com/unyt-org/uix-base-project-routing)
* [UIX Base Project + Login](https://github.com/unyt-org/uix-login-project)
* [Localization](https://github.com/unyt-org/example-localization)
* [Simple Messenger](https://github.com/unyt-org/example-simple-messenger)
* [Shopping List](https://github.com/unyt-org/example-shared-list)
* [Website Screenshot Tool](https://github.com/unyt-org/example-website-screenshot)
* [Tic-Tac-Toe](https://github.com/unyt-org/example-tic-tac-toe)
* [Weather App](https://github.com/unyt-org/example-weather-app)
* [Artwall](https://github.com/unyt-org/example-artwall)
* [Video Call](https://github.com/unyt-org/example-video-call)
## Browsers support
*Certain features of UIX are also supported in legacy browser versions. The following overview is for general guidance in order to show the major browsers and their minimum version number required to use **all** of UIX's features.*
| [
](http://gotbahn.github.io/browsers-support-badges/)Chrome | [
](http://gotbahn.github.io/browsers-support-badges/)Edge | [
](http://gotbahn.github.io/browsers-support-badges/)Firefox | [
](http://gotbahn.github.io/browsers-support-badges/)Safari | [
](http://gotbahn.github.io/browsers-support-badges/)iOS Safari | [
](http://gotbahn.github.io/browsers-support-badges/)Samsung | [
](http://gotbahn.github.io/browsers-support-badges/)Opera |
| --------- | --------- | --------- | --------- | --------- | --------- | --------- |
| Chrome 120+ | Edge 120+ | Firefox 117+ | Safari 17.5+ | Safari 17.5+ | *unknown* | *unknown*
## UIX DOM
The UIX full-stack framework is built on top of [UIX DOM](https://github.com/unyt-org/uix-dom),
a standalone library that allows you to define reactive DOM elements on the frontend and backend.
The full-stack UIX framework provides many more features, but if you just need a basic reactive DOM library,
you can take a look at UIX DOM.
## Contributing
We welcome every contribution!
Please take a look at the [development guidelines](./DEVELOP.md) and the unyt.org [contribution guidlines](https://github.com/unyt-org/.github/blob/main/CONTRIBUTING.md).
## Connect with us
**Check out our [Blog](https://unyt.blog)!**
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Benedikt Strehle
🐛 🖋 📖 🎨 🤔 🚧 ⚠️ 📆 💻
Jonas Strehle
🎨 💻 📖 🤔 🚧
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
---
© unyt 2024 • [unyt.org](https://unyt.org)