Skip to main content
Oidis Framework LogoOidis Framework Logo

Web-based User Interface Framework for creating cross-platform applications based on web technologies

About

The development of the WUI Framework started as an internal project at Freescale Semiconductor (currently NXP Semiconductors) with a proprietary license. The development of the in-house software started because a framework which would fully satisfy the needs of the internally developed applications did not exist at that time. It became clear that the framework can be used as general-purpose software for the development of cross-platform applications also outside Freescale, so the license changed to open-source BSD-3-Clause to use the WUI for free and without limitations (use it as needed, just remember to keep the file headers.) After that it has been renamed to Oidis Framework together with foundation of a civic association Oidis z.s.

The main focus of the Oidis Framework is:

  • Rapid development of web applications using a single TypeScript codebase
  • Full-stack coverage — from database models to browser UI with shared types
  • Modern browser support (Chrome, Firefox, Edge, Safari)
  • Flexibility, scalability, and fully customizable user controls
  • External configuration and built-in localization support
  • Production-ready solutions with a fully automated build and release process
  • Runtime-independent source code — the developer targets the framework API, not the platform

Runtime Environments​

  • Web application — Primary target. All modern browsers supported. Runs on any web hosting or as a Node.js server application.
  • Progressive Web App (PWA) — Supported via standard PWA capabilities for offline access and mobile installation.
  • Server application — Fully supported. Node.js backend with MongoDB, deployable via Docker containers.
Historical platforms

Earlier versions of the framework supported desktop applications via CEF + Node.js and mobile applications via PhoneGap. These runtime targets have been decommissioned. The framework now focuses exclusively on web and server deployments.

Getting Started​

The Oidis Framework uses the Oidis Builder as its build toolchain. See the Installation Guide to set up your development environment, or jump to the Framework Overview for a high-level understanding of the architecture.

Project Structure​

The Oidis Framework is composed of several GitLab projects.

  • Oidis Hub - base project for any other server application
  • Oidis Connector - base project for agent-based applications — reverse tunneling, IoT, automation, data aggregation (docs)

Each project contains several repositories which behave as libraries and are managed by the Oidis Builder.

Deep Dive​

Explore the documentation by topic:

  • Framework Overview — Architecture, tech stack, and how to read the docs
  • Architecture — Frontend/backend split, dependency chain, namespace conventions
  • GUI System — Panels, controllers, data binding, tables, dialogs
  • Decorators — @Entity, @Extern, @Route, @Resolver, @Partial
  • Utilities — LogIt, ObjectValidator, StringUtils, and more
  • Builder — CLI, build process, deployment, module system
  • Conventions — Naming, formatting, file headers, JSDoc

Contributing​

Any help is greatly appreciated!

Contact Oidis at info@oidis.io for more details.

Issue Tracking​

Use the GitLab issue tracker to report bugs or request new features.

See also: Framework Overview | Installation Guide | Architecture Overview