16 lines
618 B
Markdown
16 lines
618 B
Markdown
# RFI Train Monitor API
|
|
API for the RFI Train Monitor.
|
|
## How to use
|
|
1. Download [Node.JS](https://nodejs.org/en/download) and install it
|
|
2. Download the repository and extract it
|
|
3. Open a command line on the folder you extracted the repository
|
|
4. Run ``npm install`` to install required modules, then ``node server.js`` to start the server instance
|
|
|
|
## API params
|
|
The API is called with 2 params:
|
|
- Arrivals: A boolean set to True for arrivals, set to False for departures
|
|
- PlaceId: The ID for the specific train station
|
|
|
|
## Rights and credits
|
|
RFI, TrenItalia are trademarks used here only for reference purpouses.
|