inspire.me

Develop

Architecture

^{Components diagram}

Tests

The project is being tested at the integration level. The tests are written using Postman (See https://blog.getpostman.com/2017/10/25/writing-tests-in-postman) and executed using newman automatically via Travis.

Data Providers

Data Provider is the concept behind data-*-service micro-services. A Data Provider is a software componente responsible for feeding data to the system. Any hydra service can be a Data Provider, it just needs to follow the following specification:

• It should serve a HTTP REST API with -at least- one GET endpoint with this signature: http://{url}/v1/data?subject=${subject}.

• It should give a JSON response with the following structure:

  • Positive response (No error):

    {
        "statusCode": 200,
        "statusMessage": "OK",
        "statusDescription": "Request succeeded without error",
        "result": [
            { ... }
        ]
    }

  • Negative response (Error):

    {
        "statusCode": 500,
        "statusMessage": "Server Error",
        "statusDescription": "An error occurred on the server",
        "result": {
            "error": "..."
        }
    }

Deploy

Clone the repo in any unix-based machine and run:

npm install
# Set .env params
npm start