Table of Contents

• Folders
  • auth
  • client
  • data
  • feeders
  • idas
  • misc
  • public
  • routes
  • schema
  • spec
• Files
  • .jscsrc
  • .jshintrc
  • app.js
  • config.js
  • Gruntfile.js
  • package.json
  • setup-test-env.sh
  • utils.js

Contains the files with the functions needed to interact with Keyrock and its Oauth2 Authentication flow. See more inside.

Symlink to the client side.

Contains the Open Data restaurants file provided by the Basque Government, to use with the restaurant feeder to fill the restaurant-data image.

Set of tools to generate restaurants, reviews and reservations using the dataset mentioned below. You can see further instructions regarding it's usage inside the folder.

ul20.js contains the ultralight 2.0 functions needed to generate new Sensors and update them in IDAS.

Contains a simple node.js script that allows to retrieve a Oauth token using the Resource Owner Credentials Grant from Keyrock. See it's usage.

This folder is usually intended for static files only, but in our case, the application is served by Apache server, as it is much better than Node in serving static files.

Defines the application routes and the logic to interact with Orion. orion.js is the file containing the functions that interacts with the Context Broker. Also, the methods and functions will handle the data received through the server API. This includes not only the methods for creating, reading, updating and deleting items, but also any additional logic.

schema.js contains the schema types definitions to validate restaurants, reviews and reservations entities.

jasmine based end to end tests. See more inside.

JSCS is a code style linter and formatter for your style guide. This file contains the preset and configuration selected for this project.

Another code style linter. Includes ES6 support.

app.js is the starting point of the application. It loads everything and begins serving user requests.

Simple template that allow us to configure several parameters for the GEris integration.

Grunt task runner configuration file. It contains a set of tasks to automate and perform repetitive tasks like linting or testing.

Provides information to npm that allows to identify the project as well as handle the project's dependencies.

Script that launches a testing scenario and run the tests. In case of failure, it dumps the docker logs to the standard output.

utils.js contains a large set of functions to handle input and output data, as well as the logic needed.