Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.45 KB

README.md

File metadata and controls

34 lines (21 loc) · 1.45 KB

API for QuienEsQuien.wiki

QuienEsQuien.Wiki API. DOCS. Source.

v3.0

This API server is based in Exegesis Express. It is configured via a swagger.json file (based on the OpenAPI v3 specification). It requires a running instance of elastic-poppins.

Usage

A public API console is available at: https://api.quienesquien.wiki/v3/docs

Once the API is running, check the DOCS for usage guidance.

Use the compainion node-qqw client from NodeJS, or use qqw-poppins as a full interface to browse the data.

Installation for development

  • Install and run elastic-poppins.
  • Clone Repo
  • npm install
  • Set ELASTIC_URI environment variable (ex: ELASTIC_URI=https://user:pass@domain:port)
  • Start the server with npm run start
  • Make requests to http://localhost:10010

Deployment for production

  • Build docker container
  • Set ELASTIC_URI environment variable (ex: ELASTIC_URI=https://user:pass@domain:port)
  • Set NODE_ENV=production
  • Run docker container. Only one instance is needed.