Skip to content

Latest commit

 

History

History
82 lines (47 loc) · 3.76 KB

README.md

File metadata and controls

82 lines (47 loc) · 3.76 KB
Raw

logo Busy Hours

Busy Hours is web tool to allow easy editing of OpenStreetMap public transport hours. Give it a try !

screenshot

In Busy Hours, you can view public transport lines (route or route_master relations) and set the operating hours, the peak and off-peak hours and frequencies at these times. It uses the interval, interval:conditional and opening_hours tags documented on OSM wiki.

Usage

Direct links

You can create direct links to load public transport routes :

  • http://yourhost.net/#/line/1234 : load relation route master 1234
  • http://yourhost.net/#/line/1234/trip/4567 : load relation route 4567 (part of route master 1234)
  • http://yourhost.net/#/load/2468 : load relation 2468 (can be route or route master, there will be an automatic redirect)

Develop

To run the project locally, you need to first git clone this repository, and have NodeJS >= 9 installed on your computer.

Then, install project dependencies using npm install. Now, you can use following commands to work.

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Translations

You can contribute to the translation of the user interface on Transifex.

Translation stings are managed using JSON configuration files, automatically generated using i18nline tool. When editing code, launch manually npm run i18n:build to update these configuration files. They will be uploaded to Transifex when they will be merged in master branch.

When a language is fully translated, a PR will be automatically created from Transifex. We need to launch npm run i18n:fix before merging.

Transifex config

filters:
  - filter_type: file
    file_format: KEYVALUEJSON
    source_language: en
    source_file: src/config/locales/en.json
    translation_files_expression: src/config/locales/<lang>.json

Doc

Documentation

Documentation of the source code uses JSDoc syntax. Readable documentation can be generated using npm run doc command, and will be available as an HTML page in doc/ folder.

Configuration

Various components of the editor can be configured for the instance manager. Main files you can edit are :

You can either make temporary changes by editing these files in your build/ folder, or making changes permanent by editing in public/ folder (and rebuild using described procedure above). Note that to take into account changes made in src/ subfolders, you have to rebuild code (using npm run build, see above).