Important Links

Source Code

Nominatim-Feedback-Reporter

Previous Posts

• Community bonding
• Phase-1 Update

Hosted server

• Nominatim-Feedback-Reporter-UI
• nominatim-Feedback-Reporter-API

About the project

This is a Google Summer of Code project, which has been developed over the Summer of 2021 by Yash Srivastava (darkshredder). This project is mentored by Marc Tobias (mtmail) and Sarah Hoffmann (lonvia).

Project Description

OpenStreetMap’s main search engine Nominatim did not provide a way to report feedback on the search results that they think to be wrong.

This project aims to provide a web interface to report such feedback and store them in a logs file. So that the feedback can be analyzed, fixed and can be re-run by the maintainers to see if the problem is still there.

Implementation

The following step was followed to implement this project:

• Selecting the frontend and backend framework for the project.
  • For frontend we used svelte.
  • For backend we used falcon.
• Finding a way to fetch multiple results for reverse geocoding as nominatim only returns a single result.
  • We used overpass API to fetch multiple results and then to provide an option to select a correct result base on reverse search results.
• Hosting the frontend and backend code on the server.
  • Our frontend UI can be found here.
  • Our backend API can be found here.
• Testing the frontend and backend code.
  • We used puppeteer and mocha to add integration tests to the frontend.
  • We used pytest for unit testing backend code.
• Setting up the continuous integration pipeline.
  • We used GitHub Actions to integrate the CI pipeline to test as well as build our frontend and backend code.

Final product at the end of the GSoC

… See full entry

Hello everyone! In my previous diary entry, I discussed a brief of my project. Now, as the first phase is over, I would like to make an update of my project, “Nominatim Feedback Reporter”, which is under development.

Source Code

The source code can be found in the following GitHub repository: https://github.com/darkshredder/nominatim-feedback-reporter/ It also contains a README.md file for the instructions to install the project for local setup.

Server is Online

We have a development server up and running, which contains the following things:

• The feedback interface, which is the main project, can be found here: https://gsoc2021-feedback.nominatim.org/feedback/.
• The OSM data imported through Nominatim is only for India and is not regularly updated. Currently, it contains data from 20-05-2021.
• Using the reverse-search method for reporting feedback can show data outside India as it uses Overpass API, which contains whole planet OSM data.
• As it is a development server, feedbacks are being stored but will be deleted later.
• We regularly update the UI as the code is evolving, so don’t forget to refresh your browser’s cache.

More about the code

In this section, I will talk more about the code, how it is structured and implemented.

Frontend

… See full entry

About Me

I am Yash Srivastava, an undergraduate student from the Indian Institute of Technology at Roorkee in Uttarakhand, India. I usually spend my time exploring different technologies and creating various projects.

Apart from development, I enjoy solving rubix’s cubes, reading books, watching anime. I also love adventure sports and travelling to different places.

Journey to OSM

I was working on creating a website for my college society where we needed to integrate a map to find the location of our college society.

At first, I tried with Google Maps integration, but the location was not found there and integrating it also required some API keys, which involved more work. Later while searching for alternatives, I found out about OpenStreetMap and how we can integrate it with our website and make changes to its database in a hassle-free way.

GSoC Project: Interface for reporting search bugs for Nominatim

The project proposal can be found here

Currently, there is no standard platform where users can report geocoding bugs or send feedback. Generally, if a user wants to give feedback or report a bug, one has to have a GitHub account and then create an issue that is not feasible. Thus we aim to create an Interface for reporting search bugs for Nominatim.

It will have the following project goals:

1. The interface will be mobile-friendly.

2. The backend will store log files for the reported bugs.

3. Test suit will be created and iterated parallel to both frontend and backend.

Since this year GSoC has a shorter period thus we will have the following stretch goals:

1. We will be adding a python script that will export log files to a CSV format that can be processed through Geocode-Tester to recheck the reported bugs.

2. Dockerizing the whole application for the portability of code.

3. Creating a Continous Integration pipeline using GitHub-Actions.

4. Adding internationalization support.

… See full entry