pelias / pelias/query

Merge this code back into pelias/api

Open
#86 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ideas
Dominant language
JavaScript
Stars
13
Forks
31
PR merge metrics
No merged PRs in 30d

Description

A few years back we split this code out, I think to set up for the possibility that more areas of our code would make calls to Elasticsearch besides just the API.

This hasn't panned out, and now there's a bit of extra friction to changing our query code, since we have to make changes in this repo, and then update the version in the API.

For development, it introduces a lot of extra work, especially for a Docker based approach, but also locally, as running npm link correctly is at best a timewaster, and easy to get wrong.

Unless we have a really good reason I'm forgetting, I think we should move all this code back into https://github.com/pelias/api. It would be one less package/repo to manage.

@missinglink, your thoughts?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the pelias/query repository with pelias/api and inventorying the query code and package/version boundaries. Review the Docker-based and local development workflows, including the npm link concerns. Done means the query code is consolidated in pelias/api and the extra repository and synchronization friction are removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, backend, developer-experience
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.