Repository files navigation

Neutralinojs is a lightweight and portable desktop application development framework. It lets you develop lightweight cross-platform desktop applications using JavaScript, HTML and CSS. Apps built with Neutralinojs can run on Linux, macOS, Windows, Web, and Chrome. Also, you can extend Neutralinojs with any programming language (via extensions IPC) and use Neutralinojs as a part of any source file (via child processes IPC).

• Neutralinojs vs. Electron, NW.JS, Tauri, NodeGui, Flutter, .Net MAUI, Wails
• Neutralinojs vs. Electron vs. NW.js (2018)
• Roadmap 2024
• Release notes

Get started with the neu CLI:

# Creating a new app npm i -g @neutralinojs/neu neu create hello-worldcd hello-world neu run# Building your app (No compilation - takes less than a second) neu build

You can use your favorite frontend frameworks:

# Creating a new React-based appneu create hello-react -t codezri/neutralinojs-react

Start building apps:neutralino.js.org/docs

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. Neutralinojs doesn't bundle Chromium and uses the existing web browser library in the operating system (Eg: gtk-webkit2 on Linux). Neutralinojs implements a WebSocket connection for native operations and embeds a static web server to serve the web content. Also, it offers a built-inJavaScript client library for developers.

Ask questions on StackOverflow using tagneutralinojs

Please check thecontribution guide. We use GitHub Discussions and Discord for quick discussions.

• Join on Discord
• Start a thread on Discussions

Neutralinojs contributors:

Image created withcontributors-img.

• Builds are powered byBuildZri
• Releases are powered byReleaseZri

Organizations and individuals support Neutralinojs development. See:https://codezri.org/sponsors

If you like to support our work, you can donate to Neutralinojs viaPatreon orGitHub Sponsors.

• Neutralinojs core: MIT. Copyright (c) 2021 Neutralinojs and contributors.
• C++ websocket client/server library: BSD-3-Clause fromzaphoyd/websocketpp. Copyright (c) 2014, Peter Thorson. All rights reserved.
• JSON parser library: MIT fromnlohmann/json. Copyright (c) 2013-2022 Niels Lohmann.
• Cross-platform webview library: MIT fromwebview/webview. Copyright (c) 2017 Serge Zaitsev.
• Cross-platform tray library: MIT fromzserge/tray. Copyright (c) 2017 Serge Zaitsev.
• Cross-platform GUI dialogs library: WTFPL fromsamhocevar/portable-file-dialogs. Copyright (c) 2018—2020 Sam Hocevar
• Base64 encoder/decoder library: MIT fromtobiaslocker/base64. Copyright (c) 2019 Tobias Locker.
• Cross-platform known platform directories API: MIT fromsago007/PlatformFolders. Copyright (c) 2015 Poul Sander.
• C++ logging library: MIT fromamrayn/easyloggingpp. Copyright (c) 2012-2018 Amrayn Web Services. Copyright (c) 2012-2018 @abumusamq
• Cross-platform process library: MIT fromeidheim/tiny-process-library. Copyright (c) 2015-2020 Ole Christian Eidheim.
• Asio standalone C++ library:Boost License v1.0 fromchriskohlhoff/asio. Copyright (c) 2003-2021 Christopher M. Kohlhoff
• Cross-platform C++ clipboard library: MIT fromdacap/clip. Copyright (c) 2015-2021 David Capello
• Cross-platform C++ system information library: CC0 1.0 Universal fromThePhD/infoware. Written in 2016-2020 by nabijaczleweli and ThePhD
• Cross-platform C++ filesystem watcher library: MIT fromSpartanJ/efsw. Copyright (c) 2020 Martín Lucas Golini
• Logo design credits:IconsPng. Copyright free as mentioned in their website.

See the complete license file