Home
In this documentation will be able to learn how to install and create an entire project using OnixJS as your Node.JS Platform Choice, from OnixJS Applications / SOA Services to Client Applications.
Disclaimer: This framework is in active development and won't be ready for production until we reach release candidate.
- Alpha release date: Feb 2018
- Estimated date for beta release: May 15 2018
- Estimated date for release candidate: EO2Q/2018
OnixJS is the brand new Node.JS Real-Time Framework, built from scratch to address goals like High-Availability, High-Performance, Security, Flexibility, and Stability.
HINT: For now is recommended to clone and execute the examples than following the documentation steps, during alpha API Artifacts might quickly change the syntax or behavior and the documentation might be behind of you easily start a project.
The following starter provides you with the configurations to start coding right away.
Download: OnixJS Starter
After you clone the starter, you will simply be required to install the dependencies.
$ cd starter
$ npm installThen you can start the server using
$ npm startYou should be able to see something like:
Loading Onix Server Version: 1.0.0-alpha.23
Example Component is Alive
ONIXJS HOST LOADED: Listening on port 9000
LOADEDAfter your starter project is up and running, you are now able to create your own applications. Please consider using the visual studio code plugin that provides you with snippets to easily create your
- SOA Services.
- Modules.
- Datasources.
- Models
- Services.
- Renderers.
- Components.
- ACL Rules.
- ACL Groups.
Install the plugin from your VCode or the Marketplace
Alternatively, you might want to run any of our provided examples currently implemented in the following frameworks: