Project Description

This is a NodeJS / Express application. It is written in TypeScript, and uses Swagger for REST API routing.

Download Node from nodejs.org. Minimum required version is 6.9.1. Node distributions include NPM, the Node Package Manager.

The project dependencies are declared in package.json. They can be installed by NPM or Yarn.

npm install

NOTE: On Windows, it is possible for the Node modules installation by either NPM or Yarn to fail with a message stating a staging directory could not be renamed. Try disabling the Antivirus (both Real-time and Cloud-based protection). Another thing to try is to change the maximum path lenght, kept in the MAX_PATH environment variable, originally set to 260 characters, to a larger value:

SET MAX_PATH=10000

Configuration is handled by Node Config, which supports multi-level overrides. Default configuration is stored in ./config/default.json file. For non-dev environments, overriding configuration is stored in ./config/{$NODE_ENV}.json file, where NODE_ENV is the name of the environment variable determining the deployment environment (e.g. dev, ci, staging, production).

In the root directory of the project, run

npm start

Then, open a browser and point it to

http://localhost:8000

The actual port number is set in the project configuration (see Configuration above)

In the project root directory, run

npm test

The TypeScript options specify that the transpiler should create source code maps, which make it possible to debug the original .ts files while their counterpart .js files are being executed.

The project includes Visual Studio Code tasks configuration as well as a launch configuration.

Visual Studio Code can run tasks. To run a task, open the Command Palette (View->Command Palette or Ctrl-Shift-P), then select "Run Task" command, and select the task to run.

• The build task invokes the TypeScript transpiler and converts the TypeScript code to JavaScript, ready for execution. The build task is also set as a default build task so it can be invoked with "Tasks: Run Build Task" command (Ctrl-Shift-B).

• The watch task will start the TypeScript transpiler in watch mode, which will monitor the source files for changes and will do on-the-fly transpiling. The watch task will continue running until it is stopped by invoking "Tasks: Terminate Running Task".

• The test task runs all unit and integration tests. The task is configured as a designated test task in Visual Studio Code, and can be executed directly with "Tasks: Run Test Task".