mirror of
https://gitlab.com/openstapps/openstapps.git
synced 2026-01-06 21:42:49 +00:00
32 lines
1.5 KiB
Markdown
32 lines
1.5 KiB
Markdown
# @openstapps/core
|
|
|
|
[](https://gitlab.com/openstapps/core/commits/master)
|
|
[](https://npmjs.com/package/@openstapps/core)
|
|
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
|
|
[](https://openstapps.gitlab.io/core)
|
|
|
|
StAppsCore - Generalized model of data
|
|
|
|
## What is the StAppsCore?
|
|
|
|
The StAppsCore (SC) is a generalized model of data.
|
|
|
|
SC is based on the idea of [schema.org](https://www.schema.org). The SC structures data by describing objects as so called SC-types like: Event, Place, Date, Person, ...
|
|
|
|
Data sources of the same type of data are assigned to the same SC-type.
|
|
|
|
### Requirements for the SC
|
|
|
|
* Study processes which can be generalized are abstracted and modeled in that manner that the structure can be adapted to any german university.
|
|
* It must be platform- and software-independent.
|
|
* Search interface must be clearly specified that different working groups with different search tools can retrieve the same search results.
|
|
* Must be expandable.
|
|
|
|
### Generate documentation for routes
|
|
|
|
To generate a documentation for the routes use the following command.
|
|
|
|
```shell
|
|
node --require ts-node/register src/cli.ts routes PATH/TO/ROUTES.md
|
|
```
|