ohsome dashboard

Try out the online version here: https://dashboard.ohsome.org/

This project was generated with Angular CLI version 15.2.0.

Setup

Use node ^20.19.0 || ^22.12.0 || ^24.0.0

The following steps describe possible setups using npm.

Simple Setup

If you only want to change things in the dashboard code:

export DASHBOARD_FOLDER=$(pwd)/ohsome-dashboard # modify to your desired dashboard source folder
git clone ssh://[email protected]:GIScience/ohsome-dashboard.git $DASHBOARD_FOLDER

# eventually switch to a development branch
npm install

npm start

Advanced Setup

If you need to make changes in dashboard code and ohsome-js-utils at the same time:

export DASHBOARD_FOLDER=$(pwd)/ohsome-dashboard # modify to your desired dashboard source folder
export OHSOME_UTILS_FOLDER=$(pwd)/ohsome-js-utils # modify to your desired ohsome-js-utils source folder
git clone ssh://[email protected]:GIScience/ohsome-dashboard.git $DASHBOARD_FOLDER
git clone ssh://[email protected]:GIScience/ohsome-js-utils.git $OHSOME_UTILS_FOLDER

cd $OHSOME_UTILS_FOLDER/dist
npm link
cd $DASHBOARD_FOLDER

# eventually switch to a development branch
npm install
npm link "@giscience/ohsome-js-utils"

npm start

Development server

Run npm start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files. Be aware that only one locale is available in the dev server mode.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run mpm run build:{prod|test} to build the project. The build artifacts will be stored in the dist/ directory.

Linting

We are using eslint. To configure rules change .eslintrc.json.

Run ng lint to find out about code style problems.

Running unit tests

Run ng test to execute the unit tests via Karma.

Internationalization (i18n) and localization

To enable translations in html templates use the i18n directive:

<h1 i18n>Welcome</h1>

To enable translations in typescript code use $localize-template strings:

const category = $localize`high`;

To actually do the translations run npm run extract-i18n.

This will analyze the application and generate a source file with ids and original text snippets from html and typescipt code in one place.

src/locale/messages-source.en.json

Do a file compare with the destination language file src/locale/messages.de.json and translate everything from the source into the target language.

Make sure to maintain or update the ids from the source to the target.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities. Run ng e2e to choose an e2e platform that angular will install for you.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.