gtfs-display/readme.md

56 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2022-05-03 23:21:29 +02:00
# GTFS-Display
2022-05-03 22:52:12 +02:00
monitoring data from GTFS feed
## Table of Contents
0. [General](#General)
1. [Quick Start Guide](#Quick-Start-Guide)
2. [Setup](doc/setup.md)
2022-06-20 08:51:50 +02:00
3. [Next Steps](#next-steps)
2022-05-03 22:52:12 +02:00
# General
This repository provides a service for
[GNU/Linux](https://www.gnu.org/gnu/linux-and-gnu.en.html)
operating system.
As a front end service,
it interacts with this
2024-01-21 22:19:28 +01:00
[API](https://git.wtf-eg.de/dancingCycle/pg-rest-api).
2022-05-03 22:52:12 +02:00
# Quick Start Guide
## Preparation
* check out project on a GNU/Linux development system and change into the project root folder
```
git clone git@github.com:Software-Ingenieur-Begerad/gtfs-display.git
```
* run the following instruction to install dependenies
```
npm i
```
## Development setup
* run the following instruction to start the service in development mode
```
npm run start
```
## Production deployment
* run the following instruction to build the service for a production host
```
npm run build
```
2022-06-20 08:51:50 +02:00
# Next Steps
* Which agency has already delivered data?\
How long is the delivered data valid?
* Show 1/2/3/4 weeks in the past, present and future how many trips of agencies are available or valid!\
Does the number of trips change significantly? Is it a gap in data delivery?
* Subpages or pages should not need to do a full reload of data for UI interaction or pages or subpages switches!