TF-IDF Server Release Notes

The settings.json file required for all platform versions and is loaded during server startup.

When a new release is updated, the older relase executables will be deleted from this repository.

DON'T FORGET TO DOWNLOAD THE settings.json ALONG WITH THE PLATFORM RELEASE!

Installation

First download the following files into the same folder/directory,

1. tfidf-server.exe (Windows x64), tfidf-linux, or tfidf-macos standalone executable
2. settings.json = defines the host name, IP port, and password

Start the standalone executable

> tfidf-server.exe|tfidf-linux|tfidf-macos

The response should be similar to,

>  localhost server running on port 3000

Now, open your browser to

URL: http://localhost:3000/about

List all routes

To list all routes available, use

http://localhost:3000/

Settings.JSON

Edit the settings.json to specify the host, port, and password.

{
    "domain": "localhost",
    "host": "localhost",
    "port": 3000,
    "password": "5f4dcc3b5aa765d61d8327deb882cf99"
}

The password is an MD5 hash. Use the MD5 route to determine the MD5 hash value,

http://localhost:3000/md5/password

where password is yout plain text password, then copy and paste (without double quotes) to the settings.json (the password for the above is: password)

Release Schedule

Whenever the code base is updated, a new standalone executable is created and replaced with the existing executable.

Version     Date        Changes
1.0.3       9/20/2019   Added shutdown, MD5 and directory routes
1.0.2       9/14/2019   Updated license to AAL, https://opensource.org/licenses/AAL
1.0.1       9/14/2019   Change ABOUT route to read PACKAGE.JSON, implemented POST method for TFIDF route
1.0.0       8/1/2019    Added CORS to the API routes, included a sample HTML with embedded JavaScript
1.0.0       7/31/2019   Initial Commit

EOL or End-of-Life

When a piece of software is useful, there should never be an EOL doctrine. The intention for tfidf-server is to achieve immoratlity ;).

At some point of time in the future, this project may appear to be dead and abandon. The opposite will be true!

When this project reaches that stage, this project has matured to a level where maintenance is minimal (mostly updating to latest version of Node).

Patrick Ingle
Developer
July 31, 2019