gisat/be-metadata repository overview

⁠Metadata Service

This microservice is used to process cor metadata about the gisdata records.

⁠Graph Model

Metadata structure is composed into graph model of nodes (points) and edges (relations between nodes).

⁠Documentation

• API (Swagger): Visit http://HOST:PORT/openapi url after the start.
• Check /doc code folder for configuration samples or application changelog.
• All executable scripts can be found in package.json
• Read Readme files in other code sections.

⁠Install and Run

⁠DEV - localhost

1. Install Node.js with NPM
2. Install and run Neo4J Graph Database
3. Clone the repositry
4. Create .ENV file by example in /doc folder. Setup properties by your environment.
5. Go to project folder and open terminal (CLI)
6. Run npm install for application installation.
7. Run npm run dev for developer run.

⁠DEV - Docker Compose

1. Install Docker by your platform
2. Clone the repository
3. Go to project folder and open the terminal (CLI)
4. Create docker-compose.dev.yml file by the sample in /doc folder. Update ENV values by your setup.
5. Run docker compose -f docker-compose.dev.yml up --build for developer run

⁠DEV - DevContainer

1. Install Docker by your platform
2. Clone the repository
3. Open this repository as DevContainer using IDE

⁠Test and Debug

Tests are written in /tests folder. Scenarios contains two types of tests:

• functional (code blocks with no requirement to environment)
• integration (code requires dabatabase, IO, CLI etc.)

It is posible to run all tests together (npm run test), or choose the specific type by package.json script selection.

⁠External sources

• Fastify doc: https://www.fastify.io/⁠
• Neo4J doc: https://neo4j.com/product/neo4j-graph-database⁠
• Debug NodeJS in VS Code: https://code.visualstudio.com/docs/nodejs/nodejs-debugging⁠