These instructions are for installing MELGenKey
20241122

General Notes:
These instructions are for Windows, macOS or Linux. MELGenKey should run
on all three platforms.

The words node, node.js and nodejs are used interchangeably to refer to
the JavaScript runtime environment (usually refered to as nodejs).

Prerequisites:
You should have a basic understanding of using a command prompt/terminal.


1.  Open the command-line program for your OS (Command Prompt or PowerShell
    on Windows, and Terminal on both MacOS and Linux).

      To bring up the Command Prompt on Windows:
      (1) Open the Start menu.
      (2) Select All Programs.
      (3) Select Accessories.
      (4) Select Command Prompt.

      To bring up the PowerShell on Windows:
      (1) Click Start.
      (2) Type PowerShell.
      (3) Click Windows PowerShell.

      OR

      (1) From the Start menu, click Start.
      (2) Click All Programs.
      (3) Click Accessories.
      (4) Click the Windows PowerShell folder.
      (5) Click Windows PowerShell.

2.  Type "node -v" (without the quotes) and press RETURN. If nodejs is already
    installed you will see its version number on the screen, go to Step 4.

3.  If nodejs is NOT already installed:
      3a.  Download the correct installer from https://nodejs.org/en/download/
           for your system (Windows Installer (.msi) for Windows or macOS
           Installer (.pkg) for macOS or Linux Binaries for Linux).
      3b.  Run the installer by double-clicking on the installer icon or,
           for Linux, install the binaries. For installation help on Linux,
           see https://github.com/nodejs/help/wiki/Installation
      3c.  Type "npm install npm --global" (without the quotes) and press
           RETURN.
      3d.  Type "node -v" (without the quotes) and press RETURN. If nodejs
           is installed you will see the version number on the screen.

4.  Create the folder/directory where MELGenKey will reside. This might be
    a folder/directory within your home folder/directory.

5.  Navigate into the folder/directory created in Step 4 (AKA, MELGenKey
    root directory).

6.  Download the MELGenKey zip file at
    <http://www.mlake.net/ftpl/MELGenKey/MELGenKey-v20241122.zip>.
    Move, if needed, the zip file into the MELGenKey root folder/directory
    created in Step 4. Make sure that the downloaded zip file is in this
    folder/directory.

7.  Extract (unzip) the MELGenKey zip file. Optionally, if you like, after
    the extract finishes, remove the MELGenKey zip file.

8.  While still in the MELGenKey root directory created in Step 4, type
    "npm install" (without the quotes) and press RETURN.


At this point everything should be installed.


To run:

1.  While still in the MELGenKey root directory created in Step 4, type
    "node MELGenKeySS.js" (without the quotes) and press RETURN.

2.  From your desktop, double-click on the icon labeled "MELGenKey.html"
    (without the quotes).

    OR

    From your desktop, right-click on the icon labeled "MELGenKey.html"
    (without the quotes), then left click on Open.

    OR

    In the browser address line in your browser of choice enter the proper
    address to access MELGenKey.html in the MELGenKey root directory.



Additional notes:

    Security: If you are running a Web server, turn off outside access to
              the folder/directory created in Step 4.
    Troubleshooting: If you have issues installing, email me at
                     <MarshallELake@gmail.com>.
    Documentation: Documentation for MELGenKey is accessible from within
                   the application itself.

If nothing happens when clicking an enabled menu button it is probably because
of an ad-blocker or because pop-ups are blocked in your browser settings.
(NOTE - There are no ads in MELGenKey, but there are pop-ups which ad-blocker 
blocks.)

If the node/server is not recognized, not connected or doesn't seem to be
running (even though you know it is), it may be because of an ad-blocker.
(NOTE - There are no ads in MELGenKey, but there are pop-ups which ad-blocker
blocks.) Ad-Blockers are built into some browsers. For example, if you are
using the Brave browser, go to Settings -> Shields and disable
"Trackers & ads blocking" to turn off ad-blocking.

Node may be left running in the background if you like. For Windows, MacOS,
or Linux, using a command-line program while in the MELGenKey root directory
created in Step 4, type "node MELGenKeySS.js &" (without the quotes) and
press RETURN.

Node is the part of this application which accesses files and performs
other functions which the browser is not able to do.

You may run the browser side (MELGenKey.html) without node running but
functionality will be limited.