/neutralinojs

Build web apps with native os functions

Primary LanguageC++MIT LicenseMIT

GitHub license HitCount Twitter

Hacktoberfest with Neutralinojs

NeutralinoJs is a portable and lightweight framework which lets you to develop apps with native functions that can run inside web browsers.

In electron and NWjs you have to install NodeJs and hundreds of dependency libraries. Embedded Chromium and Node creates large overhead and makes even simple apps like “hello world” considerable in size. Neutralino offers a solution for this issue.

Interested in the NeutralinoJs idea? Start with our docs and build your first Neutralino App

Read the story of NeutralinoJs here

Ask questions on Stackoverlow using tag neutralinojs

How to Develop Neutralino apps

  • Download latest Neutralino lightweight SDK from releases
  • Write code for your application
  • Double click on the neutralino binary, it will run the app on your default browser
  • Close the browser tab (Neutralino runtime will terminate automatically)

Deploying your app

  • Zip the content and share anywhere. It's fully portable

Neutralinojs can be used for

  • Web apps with native functions
  • Lightweight cross-platform apps
  • Control VMs, servers or computers in a private/public network - NeutralinoJs cloud

Platform Architecture

Contribution

Help Neutralino!

  • Give us a star 👍
  • Fork and Clone! Awesome
  • Select existing issues or create a new issue and give us a PR with your bugfix or improvement after. We love it :) ❤️

Realtime Chat Room - Slack

Mainling List - Google Group

  • 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.

Developer Guide

Required tools

To create Neutralino developer environment in your pc, install these tool kits.

Build Neutralino platform in Windows

> build

Build Neutralino platform in Linux

$ bash build.sh

Neutralino platform components will be assembled in to /dist

Build Neutralino server in Windows

> cd core-windows
> build

Build Neutralino server in Linux

$ cd core-linux
$ bash build.sh

Neutralino server will be compiled in /bin

Build Neutralino.js with webpack

$ cd neutralino.js
$ npm install
$ npm run build

Development Milestones

  • Solution Design
  • Windows Server
  • Linux Server
  • Javascript SDK
  • Documentation
  • Web site
  • Security improvements
  • Experimental Release
  • Other required features
  • Stable release
  • MacOS support

License

MIT