This documentation project serves as a starting point and reference for contributors of RERO+ projects. It summarizes technologies and modules used to develop and create an Invenio application, and more specifically a RERO ILS application.
Feel free to add:
- scripts and tools
- documentation about each technology
- examples
- etc.
New to RERO+ development? Start here:
- RERO ILS development environment installation
- Coding recommendations
- Git workflow and how to create a pull request
- General recommendations: imports, typing, serialization, etc.
- Editor configuration: commit message template, etc.
- RERO ILS debugging specifics
- Git workflow: branches, deployments, contributor flow
- How to create a pull request
- How to publish a release (automated with semantic-release)
- Development environment installation (RERO ILS)
- uv: Python packaging and environment manager used across projects
- Docker
russian_dolls: to installng-coreinrero-ils-uiandrero-ils-uiinrero-ils
- UI integration: how to integrate UI in RERO ILS
- Migrate from a NodeJS version to another
- Data graph generation: generate a graph to visualize the data structure
- Resource relations
- Jsonschema: how to write a jsonschema for RERO+ apps
- Checklist for implementing a new field in the data model
All database stuff.
invenio-dbmoduleinvenio-pidstoremoduleinvenio-recordsmodule- Sqlalchemy
- examples: data/examples/
- PID reservation (CLI)
- POST MARCXML via CURL and access token
- invenio-assets
- invenio-theme
- invenio-records-ui
- invenio-search-ui
- nvm
- Layout charter
- Layout for document views (textual representation)
- Organisation views layout customization
- RERO ILS circulation module (built on top of
invenio-circulation)