Documentation

Contents

1. Client
2. Backend
3. JSON configuration

Client

Sampo-UI's React components are documented here using Storybook.

Here is a list of the main JavaScript libraries on which the Sampo-UI client is built on:

• React – A JavaScript library for building user interfaces
• Material-UI – React components for faster and easier web development
• Redux – A Predictable State Container for JS Apps
• redux-observable – RxJS-based middleware for Redux
• Reselect – Selector library for Redux
• React Router – Declarative routing for React
• react-intl-universal – React internationalization package developed by Alibaba Group
• deck.gl – Large-scale WebGL-powered Data Visualization
• react-map-gl – React friendly API wrapper around MapboxGL JS
• Leaflet – a JavaScript library for interactive maps
• Cytoscape – an open source software platform for visualizing complex networks
• ApexCharts.js – Open Source JavaScript Charts for your website
• React Sortable Tree – A React component for representation of hierarchical data
• Moment.js – Parse, validate, manipulate, and display dates and times in JavaScript

Backend

The API provided by Sampo-UI's backend includes routes for the following search paradigms: faceted search, full text search, and federated full text or spatial search. The API is described using the OpenAPI Specification. The same specification is used for both documenting the API, and validating the API requests and responses.

An API documentation with example configuration can been seen here.

Sampo-UI's backend is based on the following JavaScript libraries:

• Express – Fast, unopinionated, minimalist web framework for Node.js
• axios – Promise based HTTP client for the browser and Node.js
• Lodash – A modern JavaScript utility library delivering modularity, performance & extras

JSON configuration

The JSON schemas for configuration files can been seen here.

These schemas cover the portal configuration file and the perspective configuration files.