# @simtech/vrp-tools

> Utilities to support VRP

Latest version **2.4.0** (published 2018-12-07) · 0 weekly downloads

## Install

```sh
npm install @simtech/vrp-tools
pnpm add @simtech/vrp-tools
yarn add @simtech/vrp-tools
bun add @simtech/vrp-tools
```

Provides the command `vrp-tools`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.4.0 |
| Published | 2018-12-07 |
| First published | 2018-01-14 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8.x |
| Dependencies | 4 |
| Unpacked size | 10.4 MB |
| Known vulnerabilities | 0 (+10 in 3 direct dependencies) |
| Install scripts | no |
| Author | SIMTech VRP Team |
| Maintainers | simtechpom |

## Links

- npm: https://www.npmjs.com/package/@simtech/vrp-tools
- npm.io page: https://npm.io/package/@simtech/vrp-tools

## Dependencies (4)

- [lodash](https://npm.io/package/lodash.md) 4.17.11
- [moment](https://npm.io/package/moment.md) 2.22.2
- [mongodb](https://npm.io/package/mongodb.md) 3.1.10
- [commander](https://npm.io/package/commander.md) 2.19.0

## Recent versions

- 2.4.0 (latest) — 2018-12-07
- 2.3.0 — 2018-12-05
- 2.2.0 — 2018-08-01
- 2.1.3-rc1 — 2018-08-01
- 2.1.2 — 2018-08-01
- 2.1.1 — 2018-08-01
- 2.1.0 — 2018-08-01
- 2.0.5 — 2018-08-01
- 2.0.4 — 2018-08-01
- 2.0.3 — 2018-06-11
- 2.0.2 — 2018-05-16
- 2.0.1 — 2018-05-16
- 2.0.0 — 2018-05-16
- 1.0.0-rc1 — 2018-01-14

## README

- [Installation](#installation)
    - [Step 1-2: Programs Required](#step-1-2-programs-required)
- [Running](#running)
- [Features](#features)
    - [genOrder](#genorder)
    - [syncCollection](#synccollection)

# Installation

## Step 1-2: Programs Required

Step 1: **Install Nodejs** - Install the latest stable version (at least 8.10.0) of Nodejs via [nodejs.org](https://nodejs.org/en/)

Step 2: **Install vrp-tools** - `npm install vrp-tools -g`

# Running

For example, create `50` orders in `Logistics_Test` table in `127.0.0.1` SQL server

If running via source code,

`node ./bin/vrpTools.js genOrder -n 50 -d Logistics_Test -S 127.0.0.1 -U sa -P mypassword`

If running directly using published `vrp-tools`,

`vrp-tools genOrder -n 50 -d Logistics_Test -S 127.0.0.1 -U sa -P mypassword`

# Features

 | ACTION         | DESCRIPTION                                                      |
 | -------------- | ---------------------------------------------------------------- |
 | genOrder       | generates n number of delivery orders and inserts into SQL DB    |
 | syncCollection | syncs mongoDB collections of given server and azure cloud server |

## genOrder

 `vrp-tools genOrder -n <n> -U [username] -P [password] -S [server] -d [database]`

| Option            | Description                        |
| ----------------- | ---------------------------------- |
| -U, --user        | username of sql db to be connected |
| -n, --numOfOrders | number of orders to be generated   |
| -P, --pass        | password of sql db to be connected |
| -S, --server      | server ip of db to be connected    |
| -d, --database    | name of sql db to be connected     |

## syncCollection

 `vrp-tools syncCollection -U [username] -c[collection] -P [password] -S[serverport] -d [databasename] -t [clouddbname] -r [cloudservername]`

| Option            | Description                                                    |
| ----------------- | -------------------------------------------------------------- |
| -U, --user        | username of mongodb to be connected                            |
| -c, --collection  | name of collection to be synced                                |
| -P, --pass        | password of mongodb to be connected                            |
| -S, --serverPort  | ip and port of server to which mongo collection to be imported |
| -d, --database    | name of mongodb to be connected                                |
| -t, --cloudDbName | name of the DB to which mongo collection to be imported        |
| -r, --cloudServer | name of the cloud server                                       |

---
_Source: https://npm.io/package/@simtech/vrp-tools · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._