A new, open source, extensible, platform-agnostic tool for remotely debugging and testing your JavaScript. Powered by node.js and socket.io.
Understand all about Vorlon.js in 20 minutes watching this video : https://channel9.msdn.com/Shows/codechat/046
Learn more at VorlonJS !
Chat with us on slack (get a free invite clicking on the badge below)
Install and run the Vorlon.JS server from npm:
$ npm i -g vorlon
$ vorlon
With the server is running, open http://localhost:1337 in your browser to see the Vorlon.JS dashboard.You may notice errors from Python, node-gyp and socket.io. This is a known issue already reported to socket.io team. This is not a blocking issue though as socket.io still works well even with this error :)
[Linux]
$ PORT=3000 vorlon[Windows]
c:\>SET PORT=3000 && vorlon //Vorlon listening on port 3000The last step is to enable Vorlon.JS by adding this to your app:
<script src="http://localhost:1337/vorlon.js"></script>If you want to run the server with SSL support proceed as follows:
- Install Vorlonjs following the steps in Easy Setup
- Navigate to the installation folder
- Modify JSON file for activation SSL support
- In JSON file set to true
- If you want to replace our localhost certificate should only change the path of the files with the private key and certificate
- Exit and save JSON file
- Navigate to the installation folder
- Modify JSON file for activation SSLAzure support
- In JSON file set to true
- Exit and save JSON file
- Navigate with https protole on your Azure WebSite
By default Vorlon.JS application logs with debug level and files are stored in the installation folder. If you want to customize logs, proceed as follows :
- Navigate to the installation folder
- Modify JSON file, add or edit the "logs" section :
- enableConsole : enabled logging to the console,
- level : allowed values : info, warn, error
- filePath : folder where log files should be store
- vorlonLogFileName : name of Vorlon.JS log file,
- exceptionsLogFileName : name of the log files for exceptions
- Exit and save JSON file
[Windows]
C:\>cd %HOMEPATH%\node_modules\vorlon
C:\Users\Username\node_modules\vorlon>notepad Server/config.json
## JSON FILE ##
{
"useSSL": true,
"SSLkey": "server/cert/server.key",
"SSLcert": "server/cert/server.crt",
"includeSocketIO": true,
"plugins": [
{ "id": "CONSOLE", "name": "Interactive Console", "panel": "bottom", "foldername" : "interactiveConsole", "enabled": true},
{ "id": "DOM", "name": "Dom Explorer", "panel": "top", "foldername" : "domExplorer", "enabled": true },
{ "id": "MODERNIZR", "name": "Modernizr","panel": "bottom", "foldername" : "modernizrReport", "enabled": true },
{ "id" : "OBJEXPLORER", "name" : "Obj. Explorer","panel": "top", "foldername" : "objectExplorer", "enabled": true },
{ "id" : "XHRPANEL", "name" : "XHR","panel": "top", "foldername" : "xhrPanel", "enabled": true },
{ "id" : "NGINSPECTOR", "name" : "ngInspector","panel": "top", "foldername" : "ngInspector", "enabled": false }
],
"logs": {
"level" : "info",
"enableConsole" : true,
"filePath" : "E:\\temp",
"vorlonLogFileName": "vorlonjs.log",
"exceptionsLogFileName": "exceptions.log"
}
}
C:\Users\Username\node_modules\vorlon>vorlon
Vorlon with SSL listening on port 1337
With the server is running, open https://localhost:1337 in your browser to see the Vorlon.JS dashboard.The last step is to enable Vorlon.JS by adding this to your app:
<script src="https://localhost:1337/vorlon.js"></script>Read further documentation about Vorlon.JS, and writing your own plugins at http://vorlonjs.com/documentation.
If you wish to work on Vorlon.JS's server or core plugin code, you'll need to clone this directory and work in it.
Vorlon is written in typescript, which is compiled with gulp. There are two main directories:
- /Server contains the code for the vorlon server, and the dashboard code
- /Server/Scripts contains the server and dashboard code
- /Server/public contains the dashboard files served by express web server
- /Plugins contains the code for vorlon core, and for the plugins
- /Plugins/samples contains the sample client web page you can use to test your dashboard
- /Plugins/Vorlon contains the client infrastructure code
- /Plugins/Vorlon/plugins contains default plugins
There is a gulpfile.js in the root folder of the repository. It contains gulp tasks to compile typescript to javascript for the plugins and the server. In addition it ensures that the compiled plugin code is copied in to the right place in the Server directory.
To compile everything (plugins, then server) run this:
gulp
To compile only plugins run this :
gulp default-plugins
To compile only server run this :
gulp default-server