Skip to main content

Getting Started

This page gets you from a fresh checkout to the first useful actions in RDFArchitect. For full deployment details, use the installation guide.

Start the application​

The shortest path for evaluation is Docker Compose.

  1. Check out the repository:
git clone https://github.com/SOPTIM/RDFArchitect.git
cd RDFArchitect
  1. (Optional) Start Apache Jena Fuseki for snapshot storage. The Fuseki quickstart has the exact command.
  2. From the repository root, start RDFArchitect:
cd docker
docker compose up --build
  1. Open http://localhost:3000 and select Open Editor.

For source development, run the backend and frontend separately. See Local development setup.

First steps in the editor​

  1. Import a schema with File → Import → Schema (RDFS). RDF/XML, Turtle, and N-Triples are supported. See Workspace and importing data.
  2. Select a package in the left navigation tree to inspect the diagram and class list. See Organising a schema.
  3. Select a class to review labels, namespace, package, attributes, associations, stereotypes, comments, and constraints (SHACL). See Editing classes.
  4. If the dataset is read-only, use Enable Editing before making changes. See Read-only mode.
  5. Export the schema or create a snapshot when you are ready to share it. See Sharing and exporting.

For a complete walkthrough, continue with the User Guide. Administrators should also review Configuration and Security before running a shared instance.