Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
niczem committed Aug 26, 2023
1 parent e841c09 commit 6352631
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,15 @@ Solution to access machine readable AIS Data. This solution uses the free web so
As this repo is a successor to the ais-api, lecacy parts are added (see legacy) Those will be removed in future versions.


## How to use
## Install on local machine

Requirements: npm & nodejs.

1. clone this repo

2. run `npm install`

3. run `npm run dev`

### Location Format
All locations are returned in this format:
Expand All @@ -20,16 +28,6 @@ All locations are returned in this format:
raw_data: (contains all the raw data)
}

### Paths

#### /:sourcetype/:source/:vehicleidentifier/location/latest
find latest position for vehicle for specified sourcetype and source
example: http://localhost:5000/ais/mt/211281610/location/latest

#### /:source/:placeidentifier/vehicles/

#### /:source/area/vehicles

### Legacy Paths

As this repo is a successor to the ais-api, some legacy paths are added. Those will be removed in future versions
Expand Down Expand Up @@ -89,13 +87,16 @@ example: http://localhost:5000/legacy/getVesselsInPort/piraeus

Output format identical to **getVesselsInArea**

## Install on local machine

Requirements: npm & nodejs.
### Paths

1. clone this repo
#### /:sourcetype/:source/:vehicleidentifier/location/latest
find latest position for vehicle for specified sourcetype and source
example: http://localhost:5000/ais/mt/211281610/location/latest

#### /:source/:placeidentifier/vehicles/

#### /:source/area/vehicles

2. run `npm install`

3. run `npm run dev`

0 comments on commit 6352631

Please sign in to comment.