Detailed instructions

This page contains detailed instructions. In case you are having problems or questions with the short getting started instruction from the README file, you may find better explanations here.

Get Openroute Service API key

For getting this API key you need to be registered on the Openroute service site.

1. Follow the link https://openrouteservice.org/dev/#/signup
2. On the opened site, fill all required fields and press the submit button or sign up with your GitHub account.
3. After registration you may be asked to confirm your email address, so please check your email provided during the registration.
4. After that you should be able to log in to your account https://openrouteservice.org/dev/#/login
5. In the opened view after logging in, you can create your token(= API key) here:

6. After creating your token(= API key), you can see it on your dashboard above

Read more about the Openrote service API limits and pricing here https://openrouteservice.org/plans/

Get Gas Prices API key

For getting this API key you need to be registered on the Collect API site.

1. Follow the link https://collectapi.com/auth.
2. Provide your email address in the opened form and then check the email you provided.
3. You should get a message and by following the instructions you will pass into your account. It is possible that your browser will not open the site, if you are pressing button in the email, try copy paste the link under the button:

4. After logging in follow the link https://collectapi.com/api/gasPrice/gas-prices-api
5. Choose the Pricing tab:

6. Choose the plan you wish (from 08.06.2022 no free subscription) by pressing subscribe button
7. After paying (if was needed) your API key may be found from the description tab:

.env File description

The .env file contains settings for the application such as database information and APIs keys. Below is an explanation about each field in this file.

1. DATABASE name of the database should be set to mapapp. Attention, if you wish to change this name, remember to change it also in the DBCreationScript.sql file(root folder)
2. DATABASE_DIALECT dialect of your database, for example mariadb. This field is needed for the Sequalize ORM setting, read more about supported dialects here: https://sequelize.org/docs/v6/getting-started/#connecting-to-a-database. Possible values for this field are: mariadb, mysql, sqlite, postgres, mssql
3. DATABASE_HOST host of the database, for example localhost
4. DATABASE_PORT port of the database, for example 8081
5. DATABASE_USER username of your database, for example username
6. DATABASE_PASSWORD password to the username, for example password
7. ORS_API_KEY Openroute service API key (=token), you should get your own from the site https://openrouteservice.org/plans/
8. FUEL_API_KEY Gas Prices API key, you should get your own from the site https://collectapi.com/api/gasPrice/gas-prices-api

Add city center areas

In the application for the routing calculation you have an option to avoid city centers. These city center areas are completely customisable. It is recommended to add city centers before the first start of the server(before calling setUp()-method). For adding city center area to the application(to the database) follow the steps:

1. Go to the online GeoJSON editor site https://geojson.io/#map=2/20.0/0.0
2. Zoom the city center you wish to add, for example Turku:

3. From the toolbar on the right press the Polygon button

4. Then draw the polygon you want to be the city center:

5. On the right you can see the generated GeoJSON object code, copy all the geometry field content:

6. After that go to the SettingsUtil.js file (server/util folder) and create a new object called YourCity + Center to the end of the file, for example TurkuCenter. Paste your copied Polygon object and add the field areaName, with YourCity + Center value:

7. After that, go to the addCityCenters()-method and put this object to the array:

8. After that go to the file index.js (server folder) and call the setUp()-method, which should be commented(or just type: await settingsUtil.setUp(); to the app.listen function):

9. And finally start the server by typing node server/index.js to the terminal. If this is not the first call of setUp()-method, you will see some errors in the terminal, ignore them. Comment setUp()-method call back.
10. After that you can check does center area saved by creating new route via center of the city and selecting avoid city center option or by going to the database and checking it there, for example by query: select * from area where areaName = “TurkuCenter”; You can add so many city centers as you wish.