zx-code-challenge

Repository containing a resolution to the back-end challenge.

Required tools

• NodeJS
• MongoDB
• Docker

Installing

Run npm install to install all dependencies used in this exercise.

Providing the service locally

1. Fill the db.mongo.url entry of etc/server.ini file with the desired (be it local or cloud) MongoDB instance url to be used.
2. Browse to lib/config and run node import.js to load the file containing the pdvs into the database.
3. Browse back to the root project directory and run node server.js to start the app locally.
4. Browse http://localhost:3000/graphql to acess the GraphQL UI.

Supported GraphQL queries with examples

• Get by ID

{ pdv(id: 1) { id tradingName ownerName address { coordinates } coverageArea { coordinates } } }

• Get Nearest

{ nearest(coordinates: "[-44.009649,-19.948064]") { id tradingName ownerName address { coordinates } coverageArea { coordinates } } }

• Create PDV

mutation { pdv (pdv: {tradingName:"trading name", ownerName: "owner name", document:"02.453.716/000202", coverageArea: {type:MultiPolygon, coordinates:"[[[[-43.36556,-22.99669],[-43.36539,-23.01928],[-43.26583,-23.01802],[-43.25724,-23.00649],[-43.23355,-23.00127],[-43.2381,-22.99716],[-43.23866,-22.99649],[-43.24063,-22.99756],[-43.24634,-22.99736],[-43.24677,-22.99606],[-43.24067,-22.99381],[-43.24886,-22.99121],[-43.25617,-22.99456],[-43.25625,-22.99203],[-43.25346,-22.99065],[-43.29599,-22.98283],[-43.3262,-22.96481],[-43.33427,-22.96402],[-43.33616,-22.96829],[-43.342,-22.98157],[-43.34817,-22.97967],[-43.35142,-22.98062],[-43.3573,-22.98084],[-43.36522,-22.98032],[-43.36696,-22.98422],[-43.36717,-22.98855],[-43.36636,-22.99351],[-43.36556,-22.99669]]]]"},address:{type:Point,coordinates:"[-43.297335,-23.013539]"}}){ id tradingName document ownerName address {  coordinates } coverageArea { coordinates } } }

Testing

While the app is running, browse to the root project directory and run npm test to execute a test suite on the provided service.

Deploying with Docker

1. Build the Docker image by running docker build -t zx-code-challenge . in the root project directory.
2. Run the previously built image: docker run -p 3000:3000 -d zx-code-challenge