Getting Started

Learn everything you need to about Vorlon.js 0.1.0 in this video

Install and run the Vorlon.JS server from npm:

$ npm i -g vorlon $ vorlon

If you are on a mac

$ sudo npm i -g vorlon $ sudo vorlon

You may receive an error from npm during installation about Python, node-gyp and socket.io. You can ignore this error as it is related to an optional module. Socket.io team is already aware of this issue.

Once Vorlon.JS is done installing, you can now run the server:

$ vorlon The Vorlon server is running

With the server is running, open http://localhost:1337 in your browser to see the Vorlon.JS dashboard.

The last step is to enable Vorlon.JS by adding this script tag to your app:

<script src="http://localhost:1337/vorlon.js"></script>

Now when you open your app you should see your client appear on the dashboard.

You can also open the sample page, which already has this script tag in it, to test your dashboard.

Read the Docs