Time Series Prediction Server

This repository contains the source code for the server of the Time Series Prediction project

Configuration

The application makes use of the node-config library for easier configuration handling. This allows for things such as:

• Environment specific file overrides
• Get and Has methods for configurations with error handling
• Comments allowed in the configuration file

The default.json is the standard configuration file, and should contain no personal information. The dev.json contains overrides which should be used during development, and has been added into the .gitignore to prevent people accidentaly uploading personal details. To change configurations simply add the dev.json file, and replace the desired options as needed

Testing

To attach the debugger for jasmine tests:

JASMINE_CONFIG_PATH="spec/support/jasmine.json" node --debug-brk --no-lazy node_modules/jasmine/bin/jasmine.js

Documentation

apidoc.js

Install apidoc with: npm install -g apidoc

Update documentation with: apidoc -i app/ -o apidoc/

View at: apidoc/index.html

More information: http://apidocjs.com/

Linting

The applicaiton makes use of ESLint to ensure code quality is met, if you feel a rule needs to be added, please add it to the .eslintrc.yml file

Note: If using Visual Studio Code, the ESLint extension can be added to provide full code check integration