Repository files navigation

REST API endpoints details. Main endpoints:

• /analyze?text=<text>

• Tested with Node 8.4.0

The server should be able to run with the default configurations.

Modify the environment variables, or create a.env file in the root folder (details).

PORT (default: 3000) The port to run the API endpoint server.

Thesrc/config.js file has general configurations. In most cases the configurations can be altered with environment variables.

InstallNode.js, and optionally installyarn.

To install dependencies runyarn ornpm install.

For all scripts you can replaceyarn bynpm if you do not have yarn installed.

• yarn start starts the server.
• yarn run dev automatically reloads the server when developing.
• yarn run build compiles pre-ES6 JavaScript to thebuild folder to use with a regular node environment.

Run the server then go tohttp://127.0.0.0:3000 (or configured port). This will show a demo HTML page where you will be able to input text to be analyzed.