README.md

Module	Status
All modules
frontend
backend

RIS Norms

This repository contains a web app supporting the Federal Documentation of Statutes (DE: "Normendokumentation") in their task of keeping the documentation of federal norms up-to-date through amendments (DE: "Fortschreibung").

The name "RIS Norms" refers to

• "RIS", which is the German acronym for "information system on the law" (DE: "Rechtsinformationssystem")
• "Norms", which makes explicit that within RIS, we're explicitly dealing with federal laws and similar documents (and not, for example, with court verdicts)

Top Level Structure of the Repository

Code

This is a mono-repository containing

• ./backend - The backend service
• ./frontend - The main browser-based entry point for users of RIS-norms
• ./LegalDocML.de - The LegalDocML.de schema files, examples and our extensions to the LegalDocDML.de schema
• ./regex - A utility for creating regex schemas

Each of the above has its own README.md with more.

Sample Data

• ./LegalDocML.de contains files in the LegalDocML.de format for testing and reference purposes

Documentation

• ./doc contains information on

  • the domain model
  • the API specification and
  • our Architecture Decision Records (ADR)

• Additionally, there is the general RIS Documentation, which shows the RIS Norms

  • architecture diagrams
  • backend JavaDocs

Development

Please refer to DEVELOPING.md for further details.

Contributions Welcome!

See CONTRIBUTING.md for details.