Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/neonious/lowjs

A port of Node.JS with far lower system requirements. Community version for POSIX systems such as Linux, uClinux or Mac OS X.
https://github.com/neonious/lowjs

Last synced: about 1 month ago
JSON representation

A port of Node.JS with far lower system requirements. Community version for POSIX systems such as Linux, uClinux or Mac OS X.

Awesome Lists containing this project

README 

        
# lowjs



low.js is a free to use and open sourced port of the JavaScript runtime Node.js with far lower system requirements, allowing it to run on cheap, power-efficient microcontroller boards based on the ESP32-WROVER module.

It also runs on Linux based systems as a smaller, faster booting alternative to Node.JS.



For more information on low.js, please visit http://www.lowjs.org/ .



This repository neither includes the ESP32 internals nor the neonious IDE. Thus, most development happens outside of the repository. Thus, see the [Change Log](https://www.neonious.com/documentation/changelog) for more activity.



## First steps



To try out low.js on a PC, try out the [chat webserver example](https://github.com/neonious/lowjs/tree/master/examples/chat_ws_webserver) in the repository, which you can run with both low.js and Node.js.



To try out low.js on a ESP32-WROVER, try out the [examples on our homepage](https://www.lowjs.org/examples/getting-started.html) on your own board.



## Compile from source



In case the [binary distributions](https://www.lowjs.org/downloads.html) do not fit your needs, you can compile from source.



Before compiling, make sure you have the following software installed:



    make g++

    automake autoconf libtool

    cmake

    python py-pip

    nodejs

    npm (if not already installed together with nodejs)



Note: Node.js is only used to transpile the low.js libs from ES6 to ES5. It is only need for the build process. The binary distributions of low.js available on http://www.lowjs.org/ do not include Node.js, of course - this would defeat the purpose.



With this software installed, please install pyyaml with pip:



    pip install pyyaml



The compilation itself can be done with these commands:



    git clone --recurse-submodules https://github.com/neonious/lowjs

    cd lowjs

    make



low.js is now built in bin and can be called via bin/low.



The lib directory is also required for low to work (it accesses it via path_to_bin/../lib) and must be copied when creating a distribution. When creating a distribution, it might also make sense to strip the binary with the strip command, to save some KB.



## Running tests



Please see the [lowjs test documentation](https://github.com/neonious/lowjs/blob/master/test/README.md).



## License / Authors / Contributions



We appreciate every person or company who is willing to contribute to low.js and its related products. We will gladly accept any code contribution which helps the cause after an appropriate review. Bug reports and suggestions are also welcome!



low.js, with exception of the adaption for ESP32, is placed under a permisse free license, allowing you to use low.js commercially and even modify it (see LICENSE file for details). The adaption of low.js for ESP32 is not Open Source, but may be used freely with the lowsync flashing tool. low.js is maintained by neonious, the makers of the neonious one microcontroller board.



### Contact us



    neonious GmbH

    Münsterstr. 246

    40470 Düsseldorf

    Germany

    

    https://www.neonious.com/

    [email protected]

    

    TEL +49 211 9241 8187

    FAX +49 211 9241 8172

    

    Managing Director / CEO: Thomas Rogg

    District Court Düsseldorf, HRB 83086



Node.js is a trademark of Joyent, Inc. (https://www.nodejs.org/). ESP32 and ESP32-WROVER are products by Espressif Systems (https://www.espressif.com/). neonious GmbH is in no way affiliated with these companies.