README.md

Notice 🔔

Neutralino v2 is ready for Linux/Windows. You can try this pre-release. Please notice that the macOS version is not yet supporting v2 implementaton (still in v1.5.0).

Neutralino is a lightweight and portable application development framework. It lets you develop cross-platform applications using JavaScript/TypeScript, HTML and CSS.

Neutralinojs vs Electron vs NW.js

Get started with CLI.

 $ npm i -g @neutralinojs/neu
 $ neu create hello-world

This documentation is for contributors. If you would like to learn Neutralinojs application development, please check this documentation.

Why Neutralinojs?

In Electron and NWjs, you have to install NodeJs and hundreds of dependency libraries. Embedded Chromium and Node make simple apps bloaty. Neutralinojs offers a lightweight and portable SDK which is an alternative for Electron and NW.js also with many advantages.

Ask questions on Stackoverflow using tag neutralinojs

Contribution

• Select existing issues or create a new issue and give us a PR with your bugfix or improvement after. We love it ❤️
• Refer to this guide for contribution guidelines.

Realtime Chat

• We use Slack for quick discussions. get your invite

Mailing List

• Join our Google group for feature proposals and requests.
• You can help us by writing sample Neutralino apps, by composing or improving documentation or by writing code.

Framework Developer Guide

This guide is for contributors. If you are interested only in application development. Please check this guide.

Installing latest GNU C/C++ compilers

Linux

No need for separate installation of compilers because Linux distributions usually have GNU C/C++ compilers installed already.

Windows

Install the latest Visual Studio IDE. Neutralinojs compilation on windows will use MSVC (aka cl.exe) C++ compiler.

Building Neutralino platform on Windows

 build.bat

Building Neutralino platform on Linux

Install GTk and webkit libraries

On Debian/Ubuntu based OS

If you are using a newer version of Ubuntu, there is no need to run the following commands.

$ sudo apt-get install libgtk-3-dev
$ sudo add-apt-repository ppa:webkit-team/ppa
$ sudo apt-get update
$ sudo apt-get install libwebkit2gtk-4.0-37 libwebkit2gtk-4.0-dev

Building Neutralino server on Windows

> cd core-windows
> build

Building Neutralino server on Linux

$ cd core-linux
$ bash build.sh

Building Neutralino server on MacOS

$ cd core-macos
$ bash build.sh

We are planning to change the build mechanism as Linux version

Make a donation

If you like to contribute by funding for sustaining our work, you can donate Neutralinojs via Patreon.

Sponsors

MacStadium offered us a free remotely-accessed physical mac-mini for Neutralinojs-mac development.

The following members are supporting us financially on Patreon.

• Just Epic
• Brian McGonagill
• Brian
• Mortarwork Studios

Licenses and Copyrights

• Neutralinojs core: GPL-3.0
• HTTP server on Linux and macOS: GPL-3.0 from yibo141/Servant. Copyright (c) Broglie yibo141@outlook.com.
• HTTP server on Windows: MIT from hckr/SimpleHTTP. Copyright (c) Jakub Młokosiewicz.
• JSON parser library: MIT from nlohmann/json. Copyright (c) Niels Lohmann.
• Cross-platform webview library: MIT from webview/webview. Copyright (c) Serge Zaitsev.

Please check all licenses from this link.

Contributors

Made with contributors-img.