SciCat Data Catalogue Developer Guide
This guide aims to help developers understand the overall structure of the software and therefore enables people to contribute to the development of the software. See also the Overview in the Operator Manual for a helicopter view of the involved components.
If you want to contribute to the software you should also read the Contributing section, which among others links to the git workflow to be used.
Getting an development environment set up
The easiest is to follow this description to get a fully running frontend and backend setup automatically using docker. Otherwise follow the Running section
Architecture
SciCat is built on micro services using the following stack:
API (Backend)
The most important part to understand is how loopback works, because it is the platform which is directly addressed as part of the development. Please check the corresponding Loopback 3 documentation for all details
Web Browser Client (Frontend)
- Angular 9+
- Angular Material Widgets and Design
- NGRX for State Management
- Loopback SDK generator for Angular
Again please of a look at the original documentation to understand how these tools and frameworks work.