start-corsesopp-api/README.md

15 lines
700 B
Markdown

# START Romagna Non-guaranteed Routes Monitor API
API for START Romagna non-guaranteed routes 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:
- Bacino: Specifies the zone to check
- Data: the date to check routes
# Rights and credits
Start Romagna, Start and the Start Romagna logo are registered trademarks and protected by copyright by Start Romagna SpA. They are used here only for reference.