Skip to content

visminer/visminertd-service

Repository files navigation

VisminerTD Service

Overview

This is the REST service of the VisminerTD project. The main objective of this service is to provide a interface between the RepositoryMiner and VisminerTD project.

Getting started

Clone the repository:

git clone https://github.com/visminer/visminertd-service.git
cd visminertd-service

Install NodeJS: https://nodejs.org/en/download/package-manager/

Install the dependencies:

npm install

Start the server:

npm start

The API will be available on http://localhost:3000/api

To change the MongoDB URL and server port update the config.js file.

You will need MongoDB installed and a project analyzed by RepositoryMiner. For more informations about the RepositoryMiner see https://github.com/visminer/RepositoryMiner.