webui/README.md

# WebUI

[![Website](https://img.shields.io/circleci/project/github/badges/shields/master?style=for-the-badge)](https://github.com/alifcommunity/webui) [![Website](https://img.shields.io/github/issues/alifcommunity/webui.svg?branch=master&style=for-the-badge&url=https://google.com)](https://github.com/alifcommunity/webui/issues) [![Website](https://img.shields.io/website?label=webui.me&style=for-the-badge&url=https://google.com)](https://webui.me/)

> Use any web browser as GUI, with your preferred language in the backend, and HTML/JS/TS/CSS in the frontend.

![ScreenShot](screenshot.png)

> :warning: **Notice**:
> 
> * WebUI it's not a web-server solution or a framework, but it's an easy-embeddable tool to use any installed web browser as a user interface.
> 
> * We are currently writing documentation.
> 
> * WebUI is not ready yet for production release.

## Features

- Written in Pure C
- Fully Independent (*No need for any third-party library*)
- Lightweight (*~160 Kb using TCC*) & Small memory footprint
- Fast WS binary communication (*App--WebUI--Browser*)
- One header file
- Multi-platform & Multi-Browser
- Using private profile for safety

## Comparison

![ScreenShot](webui_diagram.png)

|  | WebView | Qt | WebUI |
| ------ | ------ | ------ | ------ |
| Dependencies on Windows | *Windows APIs, WebView2* | *QtCore, QtGui, QtWidgets* | *No need* |
| Dependencies on Linux | *GTK3, WebKitGTK* | *QtCore, QtGui, QtWidgets* | *No need* |
| Dependencies on macOS | *Cocoa, WebKit* | *QtCore, QtGui, QtWidgets* | *No need* |

## Build

 - [Windows](https://github.com/alifcommunity/webui/tree/main/build/Windows)
 - [Linux](https://github.com/alifcommunity/webui/tree/main/build/Linux)

## Examples

 - [C](https://github.com/alifcommunity/webui/tree/main/examples/C)
 - [C++](https://github.com/alifcommunity/webui/tree/main/examples/C++)
 - [Python](https://github.com/alifcommunity/webui/tree/main/examples/Python)
 - [TypeScript / JavaScript](https://github.com/alifcommunity/webui/tree/main/examples/TypeScript)
 - [Go](https://github.com/alifcommunity/webui/tree/main/examples/Go/hello_world)
 - [Rust](https://github.com/alifcommunity/webui/tree/main/examples/Rust/hello_world)

## Supported Browser

| OS | Browser | Status |
| ------ | ------ | ------ |
| Windows | Firefox | ✔️ |
| Windows | Chrome | ✔️ |
| Windows | Edge | ✔️ |
| Linux | Firefox | ✔️ |
| Linux | Chrome | ✔️ |
| macOS | Firefox | *coming soon* |
| macOS | Chrome | *coming soon* |
| macOS | Safari | *coming soon* |

## Supported Language

| Language | Status | Link |
| ------ | ------ | ------ |
| C | ✔️ | https://github.com/alifcommunity/webui/tree/main/examples/C |
| C++ | ✔️ | https://github.com/alifcommunity/webui/tree/main/examples/C%2B%2B |
| Python | ✔️ | https://github.com/alifcommunity/webui/tree/main/examples/Python |
| JavaScript | ✔️ | https://github.com/alifcommunity/webui/tree/main/examples/TypeScript/Nodejs |
| TypeScript | ✔️ | https://github.com/alifcommunity/webui/tree/main/examples/TypeScript/Deno |
| Go | ✔️ | https://github.com/alifcommunity/webui/tree/main/examples/Go |
| Rust | ✔️ | https://github.com/alifcommunity/webui/tree/main/examples/Rust |
| V | ✔️ | https://github.com/malisipi/vwebui |

### License

> GNU General Public License v3.0

### Stargazers

[![Stargazers repo roster for @alifcommunity/webui](https://reporoster.com/stars/alifcommunity/webui)](https://github.com/alifcommunity/webui/stargazers)
Update README.md 2022-10-19 22:14:22 -03:00			`# WebUI`
Clearing Commits History 2021-03-20 19:53:42 -03:00
v2.0.3 fix * Fix bank screen in python module (webui.show()) * Fix getaddrinfo() crash sometimes * Fix wait() typo * Fist Rust complete wrapper 2022-11-01 00:26:09 -04:00			`[![Website](https://img.shields.io/circleci/project/github/badges/shields/master?style=for-the-badge)](https://github.com/alifcommunity/webui) [![Website](https://img.shields.io/github/issues/alifcommunity/webui.svg?branch=master&style=for-the-badge&url=https://google.com)](https://github.com/alifcommunity/webui/issues) [![Website](https://img.shields.io/website?label=webui.me&style=for-the-badge&url=https://google.com)](https://webui.me/)`
Clearing Commits History 2021-03-20 19:53:42 -03:00
v2.0.3 fix * Fix bank screen in python module (webui.show()) * Fix getaddrinfo() crash sometimes * Fix wait() typo * Fist Rust complete wrapper 2022-11-01 00:26:09 -04:00			`> Use any web browser as GUI, with your preferred language in the backend, and HTML/JS/TS/CSS in the frontend.`
Clearing Commits History 2021-03-20 19:53:42 -03:00
Update README.md 2022-10-19 22:14:22 -03:00			`![ScreenShot](screenshot.png)`
Clearing Commits History 2021-03-20 19:53:42 -03:00
v2.0.3 fix * Fix bank screen in python module (webui.show()) * Fix getaddrinfo() crash sometimes * Fix wait() typo * Fist Rust complete wrapper 2022-11-01 00:26:09 -04:00			`> :warning: Notice:`
			`>`
			`> * WebUI it's not a web-server solution or a framework, but it's an easy-embeddable tool to use any installed web browser as a user interface.`
			`>`
			`> * We are currently writing documentation.`
			`>`
			`> * WebUI is not ready yet for production release.`

Clearing Commits History 2021-03-20 19:53:42 -03:00			`## Features`

update readme adding comparison table 2022-10-30 15:29:10 -04:00			`- Written in Pure C`
			`- Fully Independent (No need for any third-party library)`
			`- Lightweight (~160 Kb using TCC) & Small memory footprint`
			`- Fast WS binary communication (App--WebUI--Browser)`
WebUI 2.0 readme 2022-09-24 20:34:28 -03:00			`- One header file`
v2.0.3 - TypeScript Dynamic Lib - TypeScript Dynamic Lib - Incomplete Rus wrapper - Rename of many API's - Clean all batch script 2022-10-29 21:41:20 -04:00			`- Multi-platform & Multi-Browser`
update readme adding comparison table 2022-10-30 15:29:10 -04:00			`- Using private profile for safety`

			`## Comparison`

			`![ScreenShot](webui_diagram.png)`

			`\| \| WebView \| Qt \| WebUI \|`
			`\| ------ \| ------ \| ------ \| ------ \|`
v2.0.3 fix * Fix bank screen in python module (webui.show()) * Fix getaddrinfo() crash sometimes * Fix wait() typo * Fist Rust complete wrapper 2022-11-01 00:26:09 -04:00			`\| Dependencies on Windows \| Windows APIs, WebView2 \| QtCore, QtGui, QtWidgets \| No need \|`
			`\| Dependencies on Linux \| GTK3, WebKitGTK \| QtCore, QtGui, QtWidgets \| No need \|`
			`\| Dependencies on macOS \| Cocoa, WebKit \| QtCore, QtGui, QtWidgets \| No need \|`
Clearing Commits History 2021-03-20 19:53:42 -03:00
Update README.md 2022-09-29 13:46:24 -03:00			`## Build`

			`- [Windows](https://github.com/alifcommunity/webui/tree/main/build/Windows)`
update readme adding comparison table 2022-10-30 15:29:10 -04:00			`- [Linux](https://github.com/alifcommunity/webui/tree/main/build/Linux)`
Update README.md 2022-09-29 13:46:24 -03:00
			`## Examples`

			`- [C](https://github.com/alifcommunity/webui/tree/main/examples/C)`
Adding PyPI - C++ - Fix VS2019/2022 2022-10-21 22:15:25 -04:00			`- [C++](https://github.com/alifcommunity/webui/tree/main/examples/C++)`
Update README.md 2022-09-29 13:46:24 -03:00			`- [Python](https://github.com/alifcommunity/webui/tree/main/examples/Python)`
			`- [TypeScript / JavaScript](https://github.com/alifcommunity/webui/tree/main/examples/TypeScript)`
Update README.md 2022-10-19 22:14:22 -03:00			`- [Go](https://github.com/alifcommunity/webui/tree/main/examples/Go/hello_world)`
			`- [Rust](https://github.com/alifcommunity/webui/tree/main/examples/Rust/hello_world)`
Update README.md 2022-09-29 13:46:24 -03:00
			`## Supported Browser`
Clearing Commits History 2021-03-20 19:53:42 -03:00
Update README.md Some spelling errors and other little things. 2022-10-07 23:32:30 +03:00			`\| OS \| Browser \| Status \|`
Clearing Commits History 2021-03-20 19:53:42 -03:00			`\| ------ \| ------ \| ------ \|`
WebUI 2.0 readme 2022-09-24 20:34:28 -03:00			`\| Windows \| Firefox \| ✔️ \|`
			`\| Windows \| Chrome \| ✔️ \|`
			`\| Windows \| Edge \| ✔️ \|`
Update README.md 2022-10-24 23:41:34 -03:00			`\| Linux \| Firefox \| ✔️ \|`
			`\| Linux \| Chrome \| ✔️ \|`
WebUI 2.0 readme 2022-09-24 20:34:28 -03:00			`\| macOS \| Firefox \| coming soon \|`
			`\| macOS \| Chrome \| coming soon \|`
			`\| macOS \| Safari \| coming soon \|`

Update README.md 2022-09-29 13:46:24 -03:00			`## Supported Language`

Adding the V wrapper 2022-11-01 00:59:23 -04:00			`\| Language \| Status \| Link \|`
			`\| ------ \| ------ \| ------ \|`
			`\| C \| ✔️ \| https://github.com/alifcommunity/webui/tree/main/examples/C \|`
			`\| C++ \| ✔️ \| https://github.com/alifcommunity/webui/tree/main/examples/C%2B%2B \|`
			`\| Python \| ✔️ \| https://github.com/alifcommunity/webui/tree/main/examples/Python \|`
			`\| JavaScript \| ✔️ \| https://github.com/alifcommunity/webui/tree/main/examples/TypeScript/Nodejs \|`
			`\| TypeScript \| ✔️ \| https://github.com/alifcommunity/webui/tree/main/examples/TypeScript/Deno \|`
			`\| Go \| ✔️ \| https://github.com/alifcommunity/webui/tree/main/examples/Go \|`
			`\| Rust \| ✔️ \| https://github.com/alifcommunity/webui/tree/main/examples/Rust \|`
			`\| V \| ✔️ \| https://github.com/malisipi/vwebui \|`
Clearing Commits History 2021-03-20 19:53:42 -03:00
			`### License`

v2.0.3 fix * Fix bank screen in python module (webui.show()) * Fix getaddrinfo() crash sometimes * Fix wait() typo * Fist Rust complete wrapper 2022-11-01 00:26:09 -04:00			`> GNU General Public License v3.0`
Stargazers 2022-10-20 23:50:17 -03:00
			`### Stargazers`

			`[![Stargazers repo roster for @alifcommunity/webui](https://reporoster.com/stars/alifcommunity/webui)](https://github.com/alifcommunity/webui/stargazers)`