Home

Awesome

Nimview

License Build Status Build Status Build Status

A lightweight cross platform UI library for Nim, C, C++ or Python. The main purpose is to simplify creation of online / offline applications based on a HTML/CSS/JS layer to be displayed with Webview or a browser. The application can even run on cloud and on desktop environments with the same binary application.

Status

Currently, the project is not in active development anymore. There is tauri (written in rust) that has similar goals and is much more advanced than nimview. Much more important - tauri is using webkit2 which supports state-of-the-art css and javascript. Nimview was still using webkit1 - which causes issues when using basic reactive Javascript on windows or when using modern css libraries. I will probably still review and merge PRs if you want to use nimview or if you think that those PRs are a good idea.

Features

Table of Contents

About

The target of this project was to have a simple, ultra lightweight cross platform, cross programming language UI layer for desktop, cloud and mobile applications. Nimview applications have just a few MB in static executable size and are targeted to be easy to write, easy to read, stable, secure and easy to test. The RAM consumption of basic Nimview applications is usually less than 20 MB on MS Windows.

This project uses Webview to render Desktop applications and an integrated HttpServer for Development and Cloud. It doesn't use the latest version, as the latest version stopped working with file urls.

Nimview is an interface to interact with Nim/C/C++/Python code from UI Javascript in the same way for Webview desktop applications, web and mobile applications. It registers functions in the specific languages and also can mix Nim with any of the supported targets.

Technically, the UI layer will be completely HTML/CSS/JS based and the back-end should be using either Nim, C/C++ or Python code directly. Nim mostly acts as a "glue" layer as it can create python and C libraries easily. As long as you write Nim code, you might integrate the code in C/C++, Python or even Android. The final result should be a binary executable that runs on Linux, Windows or MacOS Desktop and even Android. IOS wasn't tested yet.

The final application later doesn't require a webserver, but it is recommended to use the webserver mode during development or in debug mode. You may also use the webserver for your cloud environemnt, but make sure to use additional authentication and a security reverse proxy when running on cloud.

Node.js is recommended but not required if you want to build your Javascript UI layer with Svelte/Vue/React or the framework of your choice. The HTTP server will run when compiling the application as "debug" by default, so you can use all your usual debugging and development tools in Chrome or Firefox. Webview makes it hard to debug Javascript - especially on Windows. You might use webview for production and testing, but you shouldn't focus Javascript UI development on Webview on windows.

This project is not intended to have any kind of forms, inputs or any additional helpers to create the UI. If you need HTML generators or helpers, there are widely used open source frameworks available, for example Vue-Bootstrap (https://bootstrap-vue.org/).

Demo binary

There is a pre-build "Todo-list" demo application for windows x64 that uses a simple Svelte UI. To make it work, you need to unzip everything before running the binaries. The zip contains two .exe files, one desktop application "appTodo" and one HTTP server application "httpTodo" that opens a server on http://localhost:8000.

If you want to build this demo from source, you need to run nimble demo on the Nimview base folder.

Youtube introduction

There is some small "Hello World" tutorial for nimview on youtube: https://www.youtube.com/watch?v=OykIbez7Vfc

Minimal Python example

The project is available for python via pip install nimview and for nim via nimble install nimview. If you just want to display some simple static HTML (or alternatively a jpg), you can run:

import nimview
nimview.start("hello_world.html")

If you want to actually trigger some server code from a button, you can do following in Python:

import nimview
def echoAndModify(value): # One input value in the function signature is required
    print ("From front-end: " + value)
    return (value + " appended")

nimview.add("echoAndModify", echoAndModify)
nimview.start("minimal_ui_sample/index.html")

The same in Nim:

Minimal Nim example

import nimview
nimview.add("echoAndModify", proc (value: string): string =
  echo "From front-end: " & value
  result = "'" & value & "' modified by back-end")
nimview.start()

Nimview will automatically use "../public/index.html" as as entry page in debug mode and will try to load "../dist/inlined.html" in release mode. In release mode, the inlined.html entry point will be compiled statically into the release binary. If there are no further dependencies, the release binary can just run as single executable binary without further UI files. Keep in mind that when running in webserver mode, it will expose all files and subfolders that in the same directory as the index.html.

Javascript and HTML UI

Nimview offers an npm package "npm install nimview" which makes your life easier on the front-end. If you want to trigger back-end code from Javascript, you can do following async callback:

import backend from "nimview"
backend.waitInit().then(() => {
  backend.echoAndModify("test").then((resp) => {console.log(resp)})
})

backend.waitInit is only required if you want to immediately trigger some back-end function during initialization. Nimview takes a few milliseconds to load all functions from back-end to front-end. You don't need this function if user action triggers a back-end call.

Keep also in mind that the inlined.html is completely "inlined" for release mode and that any "defer" keyword would not work for your script tags. So your javascript may be ready before the DOM is ready for Jasascript. You may still trigger to load the javascript deferred when using

document.addEventListener("DOMContentLoaded", function(event) {

to init your javascript when the DOM is ready, for example in your "main.js" for Svelte or Vue.

Exchange data with UI

Nimview register functions to take up to 4 arguments. If you need more or if you have more complex data, it is recommended to use Json to encode your values on the client. Use a parser on the back-end to read all values and send Json back to the client. By this, you have an unlimited amount of input and output parameter values. This is easy when using python or Nim as back-end. This may also simplify automated unit testing, as you can store the specific strings as Json and only check specific Json values. Notice, that all registered functions return only strings, so the server will also just return a string value. If you need Json, you need to parse this value in javascript manually, for example with JSON.parse(). In case you want to use C++ - don't write your own C++ Json parser. Feel free to use https://github.com/nlohmann/json. You might re-use it in other code locations.

It is also possible to call front-end functions directly from back-end by using callJs. You may trigger an alert("Hello World!") on the frontend by using following Nim code:

  nimview.callJs("alert", "Hello World!")

in your back-end code. You may use as many parameters as you want. This works directy for functions in the global js "window" namespace. If you need to call a local function, you need to register it first in javascript with window.backend.mapFrontendFunction(<functionName>, function(parameter) {...}). You can then call it from back-end. Keep in mind to only use this to send visible information to the UI and not rely your application workflow on this function. Otherwise, your application might become hard to test.

Development workflow

You need to compile the back-end and usually the front-end too, when using vue or svelte. While this seems unnecessary complicated in the beginning, you will have the freedom to only restart the back-end if you have back-end changes and use some autoreload feature of webpack (vue) and rollup (svelte) for the frontend.

The setup/install with Svelte after installing nim would be:

To create a release version, just run

But if you want to change code easily, the development workflow would be:

You can also write simple integration tests with cypress using the debug (Webserver) mode. This makes automated tests nearly as simple as for Electron. Unfortunately, Cypress doesn't support IE11 and Nimview doesn't support Edge/Chromium on Windows yet. But thx to babel, there aren't many JS incompatibilities. An Edge version of Nimview is already planned.

Inline HTML to single binary

Nimview doesn't automatically create a single executable that contains the user interface for all possible scenarios. Nimview currently adds ../dist/inlined.html to the binary - and only in release mode. This HTML file shouldn't contain any external dependencies like css, images javascript as these wouldn't be included in the executable binary. You can use an inliner to inline your external dependencies. Check the svelte_todo exampple for this. There is a "npm build" command in packages.js which calls an inliner to scan dist/index.html and write the output to ../dist/inlined.html. For very small projects, you may even use an inlined HTML file directly.

Keep in mind that these inlined HTML files might also be hard to debug if they contain javascript - so you should still have some way to just open the un-inlined index.html file.

Components as diagram

nimview

Why Nim

Nim is actually some great "batteries included" helper. It is similar readable as python, has some cool Json / HTTP Server / Webview modules but creates plain C Code that can be compiled by gcc compilers to optimized machine code. You can also include C/C++ code as the output of Nim is just plain C. Additionally, it can be compiled to a python library easily. (https://robert-mcdermott.gitlab.io/posts/speeding-up-python-with-nim/).

Which JS framework for UI

There are many JS frameworks to choose to create responsive user interfaces. Svelte will create the fastest and best readable front-end code. But it is completely up to you which framework you will choose, as Vue and React have much more plugins and add-ons.

There is an example for Vue + Bootstrap 4 in tests/vue and one for Svelte in tests/svelte. For the Windows target, you need to choose a IE 11 compatible CSS library. Bootstrap 5 for example isn't compatible with IE 11 anymore.

Nimview vs Electron or CEF

Electron and CEF are great frameworks with a lot of useful utilities and both were an inspiration to this helper here. However, the output binary of electron or CEF is usually more than 100 MB and getting started with a new project without previous knowledge of Electron / CEF can also take some time. Both CEF and Electron might be great for large Desktop projects that don't need to care about RAM + Disk or that require some additional custom window color, task symbols or other features. But setting up Electron / CEF applications and deploying them takes a lot of knowledge and time, which you can safe by using this helper here. The binary output of Nimview is usually less than 2 MB. If you zip the binary, you even have less than 1 MB for a desktop application with UI. It also might just run in the Cloud as there is an included webserver You might easily run the app in Docker. Getting started might just take some minutes and it will consume less RAM, less system resources and will start-up much quicker than an Electron or CEF App. You might write the same Code and the same UI for your Cloud application as for your Desktop App. Cypress integration tests might still work as Nimview has a webserver mode that can be used for testing.

Nimview vs Eel or Neel

There are another 2 cool similar frameworks: The very popular framework eel for python and its cousin neel for nim. While the use case seems to be similar, there are some major differences:

Difference to Flask

Flask is probably the most popular python framework to create micro services and Nimview/AsyncHttpServer probably cannot compete with the easiness or with the amount of available plugins of Flask for simple python cloud applications. But the use-case is different. While flask was desinged to serve HTML and have easy RESTful routes for "get" and "post", Nimview was just designed to trigger user events from ajax using "post". Nimview will not support server side template engines as flask does. The front-end code needs to care of routes and rendering.

Nimview can also create static binaries that can run in a minimal tiny Docker container that doesn't even need an installed python environment, as long as no python code is used. So you might create containers for your application that have just a few MB. Those deploy and startup much faster than Flask applications. Make sure to avoid building with Webview when creating binaries for Docker by compiling with -d:useServer, or you need to include GTK libraries in your container.

Wails

After releasing the first 0.1.0 version of Nimview, I found out about Wails. And I found out that I nearly created a Wails clone. Just - Wails had some nice additional features that Nimview didn't had. So - Wails became a big inspiration for Nimview Version 0.2.0:

Nimview currently "borrows" its current Webview code from Wails, as the wails community still performs fixes on the old C header-only version of Webview.

Nimview still has a smaller code base and creates even smaller binaries. You also have classical languages for your back-end as C, C++ or Python code - and you can mix those with Nim. Additionally, Nimview supports Android for offline and online applications.

CSRF and Security

Nimview was made with security in mind. For the Webview startDesktop mode, no network ports are opened to display the UI. The webserver is mostly for debugging and development.
So the application doesn't need to be checked for several common attack vectors of web-applications as long as Webview is used.

However, if you create a web-application, you need perform most security mitigations by yourself, by middleware or by the javascript framework you are using. You may check owasp.org

Following CSRF protections are already included in Nimview:

Nimview stores 3 global random non-session tokens that renew each other every 60 seconds. A valid token is required for any Ajax request except "getGlobalToken". The token is queried automatically with a "getGlobalToken" request when the application starts. If the token is missing or wrong, there is a "403" error for ajax requests.

This isn't a full CSRF protection, as the token isn't bound to a session and all users that can read responses from localhost could also use this token to perform an attack (even if they may already send request directly to localhost). If you add a "Samesite" directive for cookies, you might already prevent most common CSRF attack vectors. The token check can also be disabled with setUseGlobalToken(false) for debugging, development, or in case that there is already a session-based CSRF mitigation used by middleware.

Multithreading

Nimview was initially planned to run single-threaded. But calling back-end functions stopped Webview from updating the DOM. Therefore, an additional Webview thread was added automatically that sends information back to the main thread with Nim Channels, if the application was compiled with the option threads:on. On linux, it is also recommended to use gc:orc to avoid issues with the Nim garbage collector. You can still enforce to use Nimview to be completely single threaded if you compile with -d:useWebviewSingleThreaded. Check the Nim manual on how to deal with multithreading and sharing data as multithreading is still complicate in Nim.

You may also use threads in Python or C++.

IE 11 or - "Why is my page blank?"

Nimview uses IE 11 on Windows. Unfortunately, IE 11 doesn't understand modern Javascript or ES6. Just writing modern Javascript will result in a blank white page. You therefore need to transform your code with Babel or other tools. Check the examples for this. It might be possible to use Webview2 in future on Windows to get rid of IE 11, but this is depending on external Nim libraries that offer a wrapper for Webview. It wasn't tested yet, but it may be possible to use GTK on Windows in case you really need to avoid IE 11. At the time of writing, there is no simple and stable library supporting Webview 2 for Nim, and GTK on Windows was much more complicated as just using the IE 11 engine. The examples mostly use npm run dev for daily development. These do not compile for IE 11. If you use IE11, you need to run npm run dev-ie. This is not the default, as the build takes much longer when using babel.

Using UI from existing web-applications

For Desktop applications, it is required to use relative file paths in all your HTML. The paths must point to a directory relative of the binary to the given index html file. It is not possible to use a subdirectory of the index file. You can also not use a web URL as startpoint, as this must be an existing file. It is also not recommended to load from an untrusted URL from any existing internet source, as this could easily cause a security breach. The Desktop mode is using IE11 as platform, so there might be security issues when loading uncontrolled content from internet.

Software Requirements

- install nim (https://nim-lang.org/install.html)
    avoid white-space in nim install folder name when using windows
    add path by running nim "finish" in the nim install directory, so you have nimble available
    restart or open new shell to have nimble available
- linux: yum install gcc webkitgtk4-devel npm <or:> apt install gcc libwebkit2gtk-4.0-dev npm
- windows: install node > 12.19  (https://nodejs.org/en/download/)
- nimble install nimview
- (optional for C/C++ on Windows: install gcc / make sure that minGW is in your path)
- npx degit marcomq/nimview/examples/xxx myProject

Documentation

A documentation is here