Skip to content

Latest commit

 

History

History
114 lines (73 loc) · 3.52 KB

README.md

File metadata and controls

114 lines (73 loc) · 3.52 KB

GitHub license HitCount Twitter

NeutralinoJs is a portable and lightweight framework to develop apps with native functions and it allows you to run developed app inside web browsers.

In electron and NWjs you have to install NodeJs, hundreds of dependence libraries and also the bundled app size is large even we write hello world due to embedded chromium and Node runtime. Neutralino is lightweight solution for this issue.

Interested in NeutralinoJs idea? Get started with our docs and build your first Neutralino App

How to Develop Neutralino apps

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

Deploying your app

  • zip the content and share your app anywhere. it's fully portable

Neutralinojs can be used for

  • Web apps with native functions
  • Lightweight cross platform apps

Platform Architecture

Contribution

Help Neutralino!.

  • Give us a star 😋
  • Fork and Clone! Awesome
  • Select existing issues or create a new issue thereafter give us a PR with your bugfix or improvement. We love it ❤️
  • We use Slack for discussions. get your invite
  • Join our Google group for feature proposals and requests.

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 to /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
  • Other milestones as per planed
  • Experimental Release
  • Stable Release