This repos is here for archival purposes only. This is a prototype API for managing data needs for a hockey simulation league.

Ultra Server API

Stack

Ultra Server API uses the following technologies:

• [Swagger Framework] - framework for standardizing rest features
• [Swagger UI] - interactive rest tool & schema reference
• [Exress] - modular node.js framework
• [Sequelize] - promise based orm for node.js
• [Sqlite] - sql file-based db

Install

To get the api running, follow the following steps. Note that this codebase has been tested on node.js versions v7.8.0 and greater.

$ git clone https://github.com/bstar/ultra_server.git
$ cd ultra-server
$ npm install
$ npm start

Development

To run the API with node.js dashboard, run:

$ npm run dev

To launch the API in standard mode, run:

$ npm start

To execute the swagger unit tests, run:

$ npm run test

To launch the api via swagger's continuous server mode, run:

$ swagger project start

Finally, to launch swagger's interactive edit mode, run:

$ swagger project edit

Routes

server port defaults to 10010

Boids (get/post)

/boids

Boids (get/edit/delete)

/boid/:id

Attributes (get/post)

/attributes

Attributes (get/edit/delete)

/attribute/:id

Swagger-ui

/swagger