Skip to content

Instantly share code, notes, and snippets.

@andrewwebber
Last active August 29, 2015 14:01
Show Gist options
  • Save andrewwebber/df46392c490d5d590798 to your computer and use it in GitHub Desktop.
Save andrewwebber/df46392c490d5d590798 to your computer and use it in GitHub Desktop.
Origins Cross Platform Read Me

#Origins Cross Platform ##Traditional Batch Processing Project ###Summary The goal of this project is to provide similar processing functionality found on the original desktop version found on the Microsoft Windows operating system.

###Required Software In order to faciliate broad support for as many platforms as possible the following open source technologies have been used to implement the product.

  • Node.js - execution runtime (download)
  • Mongodb - NoSQL database (download)
  • Typescript - programming lanaguage (download)

Please install the above software assets according to your operating systems recommended installation process, for example 'apt-get'.

###Configuration The origins cross platform project contains two main configuration.

  • extensions.json - delivers the ability to extend the existing lookup system.
  • configuration.js - defines input sources, output destinations and processing options.

The attributes below, within configuration.js should be reviewed before executing the program.

... input: { inputFileName: './Data/BrentNorth.csv', ... }, output: { outputFileName: './Data/processFile.csv', ... }, processingOptions: { ... view: "AAA", ... }

###Installation The origins capablity needs to be initialize before first useage. This initialization phase will populate the database for optimal usage. Below is a bash script you can run to install the required modules, compile the project and populate\optimizate the database.

npm install

tsc --module CommonJS -t 'ES5' *.ts

node populateMongo.js

###Execution Once you have configured your 'configuration.js' file with the correct input and output sources you can execute the coding of your input file by excuting the following command:

node app.js

The program will exit once execution is completed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment