An open API service indexing awesome lists of open source software.

https://github.com/probablyarth/query-server

rocketium assignment
https://github.com/probablyarth/query-server

Last synced: 26 days ago
JSON representation

rocketium assignment

Awesome Lists containing this project

README

          

# Query Server

# Environment Variables

```python
PORT = (default: "8000")
DATA_URL = (default: "https://microsoftedge.github.io/Demos/json-dummy-data/256KB.json")

```

# Running locally

```sh
# make .env file
cp .env.example .env

# install the dependencies
yarn

# run dev server with ts-node
yarn dev

```

# Building for production

```sh
# make a build output to ./dist
yarn build

# start the production build server
yarn start
```

# Endpoints

`GET /data`

```ts
# Query Parameters

sortBy - string
order - "asc" | "desc"
limit - integer
offset - integer
case_insensitive - boolean
- string // match any field with a value
```