@alpha-manager/web-interface

Alpha Manager [web interface]

This is a web interface for @alpha-manager/core written in React that connects to the running Alpha instance and allows you to control and manage your currently running tasks from a nice GUI.

Installation

$ npm i --s @alpha-manager/web-interface

Getting Started

All you have to do is import the module

const webInterface = require ('@alpha-manager/web-interface');

and start the server

webInterface ({
    port: 3000, // optional, default is 3000,
    password: "myPassword" // optional, default is "" (no password)
});

you should now be able to go to http://localhost:3000, authenticate, and start managing your tasks.

Logs

In order to see the logs from the web interface, you have to "pipe" them to the console.log function. This is meant to prevent logs from being displayed if you don't want them.

webInteface ({
	port: 3000,
    password: ""
}).logs (console.log);

Now all the logs should be logged to the console.

Running on zeit.co/now or other hosting services

If the hosting service you are using automatically binds all incoming traffic to the port you set, you can clear the "port" input when authenticating so that it automagically connects.