/rampvis-api

Node and Python FastAPI based RESTful APIs. The APIs are used by (1) RAMPVIS user interface: https://github.com/ScottishCovidResponse/rampvis-ui and (2) RAMPVIS Infrastructure management user interface: https://github.com/saifulkhan/rampvis-ontology-management-ui

Primary LanguageTypeScript

About

RESTful APIs of the RAMPVIS system. This repository consist of the following top-level folders.

  1. data-api

    • Implemented in Python, FastAPI, and other Python libraries.
    • APIs for all data.
    • API implements processing functions, e.g., analytical algorithms, propagation, scheduler agents, etc.

  2. infrastructure-api

    • Implemented in Typescript, Node.js, Express.js, and other JavaScript libraries.
    • APIs for ontology and database operations; authentication and user management; other infrastructure related services.
    • Thumbnail and search index services.

Getting Started

Sequence of starting the services:

  1. External services
  2. Internal Services

Start External Services

The infrastructure APIs are dependent on following external services:

  1. MongoDB
  2. Elasticsearch.

Start the services:

docker-compose up -d

Run the command to check the containers (e.g., es*, kib*, and mongod*) are started:

docker-compose ps

Known Issues and Solutions

  1. The elasticsearch containers require more than 2GB VM. To setup the VM size run:
# Windows-11
wsl -d docker-desktop 
echo 262144 >> /proc/sys/vm/max_map_count

Start Internal Services

The data-api and infrastructure-api are our internal services. See the data-api README and infrastructure-api README files.

BibTex