latest build

.env

@@ -1 +1,8 @@
 NEXT_PUBLIC_BASE_PATH=
+
+SCHEMA=exhibition
+DATABASE_PROVIDER=postgresql
+DATABASE_URL=postgres://admin:admin@localhost:5433/exhibition
+SPARQL_ENDPOINT=http://localhost:7878/query
+SPARQL_ENDPOINT_LABEL=Local Testing
+SPARQL_ENDPOINT_PROVIDER=oxigraph

.env.example

@@ -0,0 +1,3 @@
+VITE_SPARQL_ENDPOINT=http://localhost:3001
+VITE_SPARQL_ENDPOINT_LABEL=Local Testing
+VITE_SPARQL_ENDPOINT_PROVIDER=rest

.github/workflows/build-and-push-demo-docker.yml

@@ -0,0 +1,56 @@
+#
+name: Create and publish a Development Demo Docker image
+
+on:
+  push:
+    branches: ['demo']
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}-development-demo
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Free Disk Space (Ubuntu)
+        uses: jlumbroso/free-disk-space@main
+        with:
+            # this might remove tools that are actually needed,
+            # when set to "true" but frees about 6 GB
+            tool-cache: true
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Restore and cache Nix store
+        uses: nix-community/cache-nix-action@v5
+        with:
+          primary-key: nix-${{ runner.os }}-${{ hashFiles('**/*.nix') }}
+          restore-prefixes-first-match: nix-${{ runner.os }}-
+          gc-max-store-size-linux: 1081900000
+          purge: true
+          purge-prefixes: cache-${{ runner.os }}-
+          purge-created: 0
+          purge-primary-key: never
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+      - name: Build and push Docker image
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        with:
+          context: .
+          file: ./Dockerfile.demo
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/nextjs.yml

@@ -22,6 +22,7 @@ jobs:
   # Build job
   build:
     runs-on: ubuntu-latest
+    environment: github-pages
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -57,12 +58,10 @@ jobs:
       - name: Install dependencies
         run: bun install
       - name: create env file
-        env:
-          NEXT_PUBLIC_GAPI_OAUTH_CLIENT_ID: ${{ secrets.NEXT_PUBLIC_GAPI_OAUTH_CLIENT_ID }}
-          NEXT_PUBLIC_BASE_PATH:  /${{ github.event.repository.name }}
         run: |
           touch ./apps/exhibition-live/.env
-          echo NEXT_PUBLIC_GAPI_OAUTH_CLIENT_ID="${{ secrets.NEXT_PUBLIC_GAPI_OAUTH_CLIENT_ID  }}" >> ./apps/exhibition-live/.env
+          echo "${{ vars.LOCAL_ENV_FILE }}" > ./apps/exhibition-live/.env
+          echo NEXT_PUBLIC_GAPI_OAUTH_CLIENT_ID="${{ vars.NEXT_PUBLIC_GAPI_OAUTH_CLIENT_ID }}" >> ./apps/exhibition-live/.env
           echo NEXT_PUBLIC_BASE_PATH="/${{ github.event.repository.name }}" >> ./apps/exhibition-live/.env
       - name: Build with Next.js
         run: bun run build

.gitignore

@@ -62,3 +62,22 @@ coverage
 
 out
 apps/exhibition-live/exhibition-live
+
+packages/icons/src/assets/svgs
+manifestation/exhibition/typebox
+apps/edb-prisma-cli/migrations
+apps/edb-prisma-cli/prisma
+apps/edb-prisma-cli/prisma
+apps/edb-solr-cli/solr
+apps/edb-solr-cli/elastic
+apps/edb-surreal-api/data
+apps/edb-surreal-api/*.AppImage
+apps/edb-prisma-cli/schema.prisma
+
+
+.env
+/apps/exhibition-live/public/exhibition-corpus-riot.ttl
+/apps/edb-solr-cli/export
+.aider*
+venv/
+.venv/

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "packages/edb-sparnatural/jsonschema2shacl"]
+	path = packages/edb-sparnatural/jsonschema2shacl
+	url = https://github.com/citiususc/jsonschema2shacl.git
+	branch = main

.prettierignore

@@ -1,3 +1,4 @@
 /apps/exhibition-live/styles
 /apps/exhibition-live/public/worker.js
 /apps/exhibition-live/public/scripts.bundle.js
+/apps/edb-solr-cli/solr/solr

Dockerfile.demo

@@ -0,0 +1,50 @@
+FROM nixos/nix
+
+RUN mkdir /app
+WORKDIR /app
+
+COPY flake.nix flake.nix
+COPY flake.lock flake.lock
+
+# Cache some requirements in /nix/store
+RUN echo "extra-experimental-features = nix-command flakes" >> /etc/nix/nix.conf
+RUN nix develop
+
+
+ENV NEXT_TELEMETRY_DISABLED 1
+ENV NEXT_PUBLIC_BASE_PATH ""
+
+RUN mkdir -p /home/appuser
+RUN nix-shell -p busybox.out --run 'adduser -D -u 1000 appuser && \
+    chown -R appuser:appuser /nix && \
+    chown -R appuser:appuser /app'
+
+
+
+EXPOSE 3000
+
+ENV HOSTNAME "0.0.0.0"
+
+
+COPY . /app
+RUN chown -R appuser:appuser -R /app
+
+WORKDIR /app
+USER 1000:1000
+
+RUN nix develop --command bash -c 'bun i && bun build:packages'
+
+ENV DATABASE_URL "file:/app/prisma/dev.db"
+
+RUN nix develop --command bash -c 'bun run build:prisma && \
+	bun run prisma:exhibition:generate && \
+	prisma migrate dev --name initial --schema ./prisma/exhibition.prisma'
+
+RUN nix develop --command bash -c 'bun run cli flatImport ./manifestation/exhibition/import/Konvolut_NewYork_2024-07-14.csv  -m NewYork -n 10'
+
+EXPOSE 3001
+EXPOSE 5762
+
+COPY ./.env.example /apps/exhibition-live/.env.local
+
+CMD nix develop --command bash -c 'bun run start'

README.md

@@ -8,20 +8,19 @@ A live demo of the exhibition catalog is available here: [https://slub.github.io
 
 You might want to set your own storage backend(s) within the settings modal.
 
-## Storybook stories
+## Development Documentation
 
-The pure frontend specific component based framework, that sets the base of the exhibition catalog is documented within the Storybook.
-
-You can get a live preview of the current `develop` branch here: [https://slub.github.io/exhibition-live/storybook/](https://slub.github.io/exhibition-live/storybook/)
+Please have a look at the **[Storybook of the EDB Framework](https://slub.github.io/exhibition-live/storybook/)** for an indepth documentation of the frontend components, th cli
+and the overall architecture of the exhibition catalog and the EDB framework.
 
 # Development
 
 ## Getting Started
 
-First, run the development server:
+For a quick start install all dependencies initially build the packages and start the development server of the nextjs exhibition-live application.
 
 ```bash
-bun i && bun run dev
+bun i && bun build:packages && bun run dev:exhibition
 ```
 
 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
@@ -56,6 +55,12 @@ Other SPARQL Endpoints, like Jena Fuseki, Virtuoso, Blazegraph or GraphDB can be
 Additional effort might be needed to configure CORS and authentication and to get along with some
 Endpoints not beeing fully SPARQL 1.1 compliant.
 
+### Endpoint Configuration
+
+The configuration of endpoints within the `exhibition-live` application can either be done dynamically at runtime using
+the settings modal or by providing a `SPARQL_ENDPOINT` environment variable at build time, which disables setting the endpoint
+within the modal and is especially suitable for production deployments, where one wants to make sure all users operate on the same endpoint.
+
 ## Storybook
 
 This project uses [Storybooks](https://storybook.js.org/) to enforce reusable component based development and to document them with
@@ -68,6 +73,19 @@ bun i && bun run storybook
 
 Open [http://localhost:6006](http://localhost:6006) with your browser to see the storybook.
 
+## Testing
+
+Unit tests of core functionality is done by `jest`. For integration tests of the frontend `Cypress` is being used.
+
+### Trouble Shooting
+
+Cypress under Nix:
+it might be necessary to delete `~/.cache/Cypress`
+
+```
+rm -rf ~/.cache/Cypress
+```
+
 ## Using Docker
 
 1. [Install Docker](https://docs.docker.com/get-docker/) on your machine.
@@ -130,3 +148,16 @@ that provide additional information for the frontend, like:
 
 - the UI-Schemata for form layout and style hints
 - data mapping declarations for data conversion from and to norm data repositories
+
+# Helpful Commands
+
+Complete rebuild without cache:
+
+```
+docker compose down
+docker compose rm -f
+docker compose pull
+docker compose up --build -d
+```
+
+Deletes all images, reloads all images from repository, starts all images with building in daemon-mode, may add `docker compose logs -f` for output in following mode.

_templates/edb/frontend-package-raw/Component.stories.tsx.t

@@ -0,0 +1,39 @@
+---
+to: packages/<%= name.split("/")[1] %>/src/<%= h.changeCase.pascal(name.split("/")[1]) %>.stories.tsx
+---
+<%
+  const packageName = name.split("/")[1];
+  const ComponentName = h.changeCase.pascal(packageName);
+%>
+import React from 'react';
+import { Meta, StoryObj } from '@storybook/react';
+import { <%= ComponentName %>, <%= ComponentName %>Props } from './<%= ComponentName %>';
+
+const meta: Meta<typeof <%= ComponentName %>> = {
+  component: <%= ComponentName %>,
+  title: 'Components/<%= ComponentName %>',
+  argTypes: {
+    name: { control: 'text' },
+  },
+};
+
+export default meta;
+type Story = StoryObj<typeof <%= ComponentName %>>;
+
+export const Default: Story = {
+  args: {
+    name: 'World',
+  },
+};
+
+export const CustomName: Story = {
+  args: {
+    name: 'Storybook',
+  },
+};
+
+export const LongName: Story = {
+  args: {
+    name: 'This is a very long name to test wrapping',
+  },
+};

_templates/edb/frontend-package-raw/Component.tsx.t

@@ -0,0 +1,15 @@
+---
+to: packages/<%= name.split("/")[1] %>/src/<%= h.changeCase.pascal( name.split("/")[1] ) %>.tsx
+---
+<%
+  const packageName = name.split("/")[1];
+  const ComponentName = h.changeCase.pascal(packageName);
+%>
+import React, {FunctionComponent} from 'react';
+
+export type <%= ComponentName %>Props = {
+  name: string;
+};
+export const <%= ComponentName %>: FunctionComponent<<%= ComponentName %>Props> = ({ name }) => {
+  return <div>Hello {name} from <%= name %> Package!</div>;
+}

_templates/edb/frontend-package-raw/Doc.mdx.t

@@ -0,0 +1,19 @@
+---
+to: packages/<%= name.split("/")[1] %>/src/<%= h.changeCase.pascal(name.split("/")[1]) %>.mdx
+---
+<%
+  const packageName = name.split("/")[1];
+  const ComponentName = h.changeCase.pascal(packageName);
+%>
+import { Canvas, Meta } from '@storybook/blocks';
+import * as <%= ComponentName %>Stories from './<%= ComponentName %>.stories';
+
+<Meta title="Components/<%= ComponentName %>" />
+
+# <%= ComponentName %>
+
+<% ["CustomName", "LongName"].forEach((story) => {%>
+## <%= story %>
+<Canvas of={<%= ComponentName %>Stories.<%= story %>} />
+
+<% }) %>

_templates/edb/frontend-package-raw/package.json.t

@@ -0,0 +1,28 @@
+---
+to: packages/<%= name.split("/")[1] %>/package.json
+---
+{
+  "name": "<%= name %>",
+  "version": "1.0.0",
+  "private": true,
+  "main": "src/index.tsx",
+  "types": "src/index.tsx",
+  "sideEffects": false,
+  "scripts": {
+    "typecheck": "tsc -b",
+    "lint": "eslint \"**/*.ts*\"",
+    "lint-fix": "eslint --fix \"**/*.ts*\""
+  },
+  "peerDependencies": {
+    "@mui/material": "^5",
+    "@mui/icons-material": "^5",
+    "react": "^18"
+  },
+  "dependencies": {
+  },
+  "devDependencies": {
+    "@slub/edb-build-helper": "workspace:*",
+    "@slub/edb-tsconfig": "workspace:*"
+  }
+}
+

_templates/edb/frontend-package-raw/prompt.js

@@ -0,0 +1,11 @@
+// see types of prompts:
+// https://github.com/enquirer/enquirer/tree/master/examples
+//
+module.exports = [
+  {
+    type: "input",
+    name: "name",
+    message: "Name of the sub package",
+    initial: "@slub/edb-",
+  },
+];

_templates/edb/frontend-package-raw/src_index.tsx.t

@@ -0,0 +1,4 @@
+---
+to: packages/<%= name.split("/")[1] %>/src/index.tsx
+---
+export * from "./<%= h.changeCase.pascal(name.split("/")[1]) %>";

_templates/edb/frontend-package-raw/tsconfig.json.t

@@ -0,0 +1,12 @@
+---
+to: packages/<%= name.split("/")[1] %>/tsconfig.json
+---
+{
+  "extends": "@slub/edb-tsconfig/react-library.json",
+  "include": ["src"],
+  "exclude": ["dist", "build", "node_modules"],
+  "compilerOptions": {
+    "strict": false,
+    "resolveJsonModule": true
+  }
+}