The Data Explorer API

---

What is the Data Explorer API?

About the project

• Website: data.theglobalfund.org
• Authors: Zimmerman
• Github Repo:
  • Frontend: https://github.com/globalfund/data-explorer-client
  • Backend: https://github.com/globalfund/data-explorer-server

Mapping process

Information about the data/logic mapping process can be found in src/config/README.md

Prerequisites

In order to use the Data Explorer Data Themes API, you need to install MongoDB.

The default database configuration can be found in src/application.ts

const dbHost = process.env.MONGO_HOST ?? 'localhost';
const dbPort = process.env.MONGO_PORT ?? 27017;
const dbUser = process.env.MONGO_USERNAME ?? '';
const dbPass = process.env.MONGO_PASSWORD ?? '';
const database = process.env.MONGO_DB ?? 'the-data-explorer-db';
const authSource = process.env.MONGO_AUTH_SOURCE ?? '';

If you want to use different configuration variables then add them as environment variables

MONGO_HOST=<mongoDB host>
MONGO_PORT=<mongoDB port>
MONGO_USERNAME=<mongoDB username>
MONGO_PASSWORD=<mongoDB password>
MONGO_DB=<mongoDB name>
MONGO_AUTH_SOURCE=<mongoDB authentication source>
ALTERNATIVE_DATASOURCE_BASE=<Base URL to a different datasource, to be appended with the dataset identifier, for example "https://my.odata.source/data/dx">
DX_BACKEND_DIR=<directory where the DX backend runs, ending in a />
DX_BACKEND_URL=<URL to DX Backend, localhost would be http://localhost:4004>
PARSED_DATA_FILES_PATH=<directory where the parsed data files are stored>

Install dependencies

Whenever dependencies in package.json are changed, run the following command:

yarn install

Migrate DB models

Whenever database models in src/models are changed, run the following command:

yarn migrate

Run the application in development mode

yarn dev

Open http://localhost:4200 in your browser. Changes will be reflected once you save them.

Build and deploy with pm2

yarn deploy

Fix code style and formatting issues

yarn run lint

To automatically fix such issues:

yarn run lint:fix

Learn More

This project is created with LoopBack v4.

To learn more about LoopBack v4, check out the LoopBack v4 documentation.

How should I contribute?

• As we use semantic-release for automated git releases your commits must comply with the following commit types:

feat: A new feature
fix: A bug fix
docs: Documentation only changes
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor: A code change that neither fixes a bug nor adds a feature
perf: A code change that improves performance
test: Adding missing or correcting existing tests
chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

• Always try to reference issues in commit messages or pull requests ("related to #614", "closes #619" and etc.).
• Avoid huge code commits where the difference can not even be rendered by browser based web apps (Github for example). Smaller commits make it much easier to understand why and how the changes were made, why (if) it results in certain bugs and etc.
• If there's a reason to commit code that is commented out (there usually should be none), always leave a "FIXME" or "TODO" comment so it's clear for other developers why this was done.
• Automatic code quality / testing checks (continuous integration tools) are implemented to check all these things automatically when pushing / merging new branches. Quality is the key!