/kia

Primary LanguageJavaScriptMIT LicenseMIT

KIA Bengaluru Airport Bus UI

Local development

  • Create a .env file in the root folder of the repo with the below contents:
    VITE_MAPBOX_TOKEN=insert_mapbox_token_here
    VITE_GOOGLE_API_KEY=insert_google_api_key_here
    BMTC_API_ENDPOINT=endpoint_of_btmc_web_api
    The BMTC web api is used to refresh the src/utils/timings.json file when there are updates to bus timings. It is not publicly available. If you need it, please reach out to the team on Discord.
  • Run the below commands
    yarn install
    yarn start

bmtc_utils

This folder contains node.js scripts to query and manipulate BMTC API data.
bmtc_api_data.csv: KIA subset of the BMTC data with route names, IDs and other relevant info
get_timings.json: Gets the latest timetable and saves it to src/utils/timings.json
get_stops.json: Get the latest data of stops along all routes and saves to src/utils/stops.json

Contributing to the repo

Before raising a pull request for feature additions, please open an issue discussing the change.

Please follow the below guidelines for consistency and ease of review:

  • Configure Prettier to run on file save for your IDE
  • Use concise and descriptive commit messages