Calculate Distance Matrix 🔰

Report Bug · Request Feature

🤔 About The Project

This program, calculates a distance matrix using the Janson-Shanon algorithm, bringing the result of the distance or the travel time between two locations. To use, it is very simple, just send a file formatted correctly with the extension .csv on the client as soon as the file is processed, the server returns it on screen.

- Frontend

- Backend

🔨 Installation Default

You'll need Node.js installed on your computer in order to build this app.

git clone https://github.com/lucioerlan/calculate-distance-matrix.git
$ cd calculate-distance-matrix/client  -and-   calculate-distance-matrix/server
$ npm install

Considerations:

• Format the .csv file correctly, example of the .csv file formatted in /server
• This program was run on Linux/Windows 😄

🔥 Setup

Copy or rename the file

$ cp .env-examples .env 

Have a google account

ㅤThen get a Google API key

Finalizing configurations 💨

• After obtaining a google maps key, place it in [.env] in the GOOGLE_MAPS_API_KEY variable.

🤓 Documentation and running tests

• Access swagger http://localhost:5000/api/docs 🥇
• $ npm test

🚀 Running Default

$ /client npm start 

$ /server npm start 

Or Run Docker 🐳

$ docker-compose up -d

🔓 License

This project lives under MIT License. See LICENSE for more details. © - Erlan Lucio