Greenstand / Greenstand/treetracker-query-api

Search API to query data crossing fields and tables

Open
#90 2 comments 0 reactions 1 assignee Claimed by @kparikh9 View on GitHub
Express medium
Dominant language
TypeScript
Stars
18
Forks
65
PR merge metrics
No merged PRs in 30d

Description

This is an experimental API, the goal is to support our search function on web map:

image

The result should be a mixed list, the items of the list could be: tree item, planter, org, so we need search all of them on the server, and combinate the result to a list.

API spec:
GET /search?keyword=[treeid|planter name]
response:
{
total: 10,
list: [{
type: 'tree|planter',
data: { ... tree object | planter object}
}]
}

Currently, don't need to consider pagination, just simply return up to 10 results.

---

Some hints:

- Please read our readme for more information/guide/tutorial.
- Here is [an engineering book](https://greenstand.gitbook.io/engineering/) in Greenstand.
- To know more about our organization, visit our [website](https://greenstand.org).
- If you want to join the slack community (some resources need the community member's permission), please leave your email address.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.