Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.22 KB

README.md

File metadata and controls

44 lines (32 loc) · 1.22 KB

License: MIT JavaScript Style Guide: Standard Build Status

@planterdocs/fetch-api

A query-only API for front-end applications

Configuration

Requires MongoDB and Redis server information set as environmental variables, or via .env dotfile.

.env

# REQUIRED

REDIS_HOST=
REDIS_PORT=
REDIS_AUTH_PASS=

MONGO_URI=
MONGO_DB=
MONGO_COLLECTION=

The FireFerret client manages datastore connections, queries, and errors. Read more about fine-tuning FireFerret here.

API

└── /
    └── api (GET)
        └── / (GET)
            └── plant
                ├── /
                │   └── :name (GET)
                └── s (GET)
                    └── / (GET)
                        └── :region (GET)

Proxying

Image deploys with 80:80 open. Please use a reverse-proxy in production.