x0 JavaScript Framework

Framework for building complex, recursive OOP based real-time objects

---

📌 Overview

x0 (cross-objects /krɒs ɒb.dʒɪkts/) is a Next-Level JavaScript Framework for building robust, complex, highly structured and real-time-modifiable objects usable in a 100%-Server-Less infrastructure.

• Responsive by Design: One app, every device, standards via Bootstrap CSS
• Clean OOP Model: True object orientation, abstraction, chaining, metadata modeling
• Zero Code Duplication: Efficient, maintainable, backend-agnostic
• Kubernetes Ready: Easy cloud-native deployment
• Security: PKCS 11/15 compatible, own PKI system (non-free)
• Multiple Language Support: x0 supports multiple display languages

---

📑 Table of Contents

1. Quick Start
2. Features
3. Abstract / Purpose
4. Single Page Application
5. Documentation
6. Simple Usage
7. Technical Details
8. Security
9. Examples
10. File & Folder Structure
11. Contributing
12. Future Plans / Milestones
13. Community & Support
14. License
15. References

---

🐎 Quick Start

Try x0 now in minutes!

# clone & enter repo
git clone https://github.com/WEBcodeX1/x0.git
cd x0

# install docker
apt-get -y install docker.io docker-buildx

# docker permissions & setup (as root)
usermod -aG docker your-user

# restart (system) and pull pre-built images
docker pull ghcr.io/webcodex1/x0-app
docker pull ghcr.io/webcodex1/x0-db
docker pull ghcr.io/webcodex1/x0-test

# start x0-system
cd ./docker/
./x0-start-containers.sh

1. Add to /etc/hosts:

172.20.0.10     x0-app.x0.localnet

2. Try hello world:

http://x0-app.x0.localnet/python/Index.py

3. Try examples:

http://x0-app.x0.localnet/python/Index.py?appid=example7

Full install details including build instructions: ./INSTALL.md.

---

🌟 Features

• Cross Objects: Clean OOP, seamless data exchange between clients and network
• Responsiveness: Bootstrap CSS grid, single app for all devices
• Object Chaining / Data Abstraction: Chain objects, enjoy recursive, reusable modeling
• Zero Code Duplication / Freedom: OSI-layer abstraction, minimal backend dependencies
• Kubernetes Ready: Google Kubernetes Engine (GKE), Minikube support
• Security: PKCS-compatible, optional advanced PKI system

Learn more in Examples.

---

📣 Abstract / Purpose

x0 is designed to make advanced SPA development fun, fast, and maintainable. With zero code duplication and a clean OOP model, x0 powers complex, modern web applications.

---

💻 Single Page Application

Single Page Applications (SPAs) are modern web apps that deliver a seamless, desktop-like user experience directly in the browser. Unlike traditional multi-page websites, SPAs dynamically update content without requiring full page reloads, resulting in faster interactions and smoother navigation.

• Real-Time Updates: By using technologies like WebSockets or polling, SPAs can reflect changes instantly — ideal for chat apps, dashboards, or any application requiring live data.
• Optimized Performance: Static assets are loaded once, and only data or components needed for each interaction are fetched afterward, reducing bandwidth and latency.

---

📃 Documentation

Rendered docs: Official Sphinx Documentation.

---

📝 Simple Usage

# define object from system objects
let myRootObject1 = new sysBaseObject();
const myObject1 = new sysObjFormfieldItem(JSONConfig);
const myObject2 = new sysObjLink(JSONConfig);
const myObject3 = new sysObjButton(JSONConfig);
myRootObject.addObject(myObject1);
myRootObject.addObject(myObject2);
myRootObject.addObject(myObject3);

# register new system object
sysRegister(myRootObject1, 'MyCoolObject');

# reuse and combine
let myRootObject2 = new sysBaseObject();
const myObject4 = new sysObjMyCoolObject(JSONConfig);
const myObject5 = new sysObjMyCoolObject(JSONConfig);
myRootObject2.addObject(myObject4);
myRootObject2.addObject(myObject5);

# realtime render
myRootObject2.renderObject();

---

⚡ Technical Details

OS Compatibility:

• Ubuntu 22.04 (Jammy Jellyfish)
• Ubuntu 24.04 (Noble Numbat)
• Devuan (Daedalus 5.0)

Prerequisites:

• Apache2.0+ / WSGI or FalconAS
• PostgreSQL 13+
• Python3+, Psycopg2, Selenium

Kubernetes:

• Kubegres: GitHub
• Minikube: Partial support on Windows / Linux
• Install Instructions: ./kubernetes/README.md

Deployment:

• Linux Standalone
• Docker
• Google Kubernetes Engine (GKE)

---

🔐 Security

PKCS 11/15 compatible. Optional advanced PKI (non-free). Full details in WEB/codeX PKI Manager.

---

💡 Examples

Try 15 live examples (after local docker containers have been started):

http://x0-app.x0.localnet/python/Index.py?appid=example1
...
http://x0-app.x0.localnet/python/Index.py?appid=example15

Most examples now include a descriptive video: ./example/README.md.

---

📁 File & Folder Structure

Partial overview, see GitHub file search:

├── README.md
├── INSTALL.md
├── debian/
│   └── README.md
├── docker/
│   ├── README.md
│   ├── build-all.sh
│   └── ...
├── doc/
│   ├── index.rst
│   ├── intro.rst
│   ├── dev-examples.rst
│   ├── Makefile
│   └── conf.py
├── example/
│   ├── example1
│   └── example2
├── conf/
│   └── wsgi.conf
├── www/
│   └── sysText.js
├── test/
│   └── README.md
└── ... (more files & folders)

---

👋 Contributing

Contributions & feedback welcome! See ./CONTRIBUTING.md or open an issue.

---

⏰ Future Plans / Milestones

• Replace Apache with FalconAS Python Application Server: Repo
• Roadmap: GitHub Milestones

---

🌐 Community & Support

• Discussions
• Issues
• Docs

---

📝 License

AGPL-3.0. See ./LICENSE.

---

🔗 External References

• https://kubernetes.io
• https://www.selenium.dev
• https://www.kubegres.io
• https://www.sphinx-doc.org
• https://www.devuan.org/
• https://github.com/sl1pm4t/k2tf
• https://github.com/WEBcodeX1/http-1.2

---

_{Made with ❤️ by Claus Prüfer / clickIT / WEBcodeX}