Update README and refactor github actions

.github/workflows/test+deploy.yml

@@ -8,7 +8,14 @@ on:
   pull_request:
     branches: ['main']
 
+env:
+  # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+  NODE_VERSION: 20.15.1
+
 jobs:
+  # **********************
+  # Build
+  # **********************
   build:
     runs-on: ubuntu-latest
     steps:
@@ -17,8 +24,7 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@v3
         with:
-          # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-          node-version: 20.15.1
+          node-version: $NODE_VERSION
           cache: 'npm'
 
       - name: Install dependencies
@@ -33,26 +39,70 @@ jobs:
       - name: Copyright check
         run: npm run copyright:check
 
-      - name: Linter
+      - name: Linting and Code Quality
         run: npm run lint
 
-      - name: Build app
+      - name: Build
         env:
           BASE_PATH: '/${{ github.event.repository.name }}'
         run: npm run build
 
-      - name: Component and Unit tests
-        run: npm run test:unit+component
-
       - name: Upload build artifact
         uses: actions/upload-artifact@v2
         with:
           name: build
           path: build
           if-no-files-found: error
+
+  # **********************
+  # Unit + component tests
+  # **********************
+  unit_and_component_tests:
+    name: 'Unit and component tests'
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: $NODE_VERSION
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Component and Unit tests
+        run: npm run test:unit+component
+
+  # **********************
+  # End to end tests
+  # **********************
+  e2e_tests:
+    runs-on: ubuntu-latest
+    needs: build
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: $NODE_VERSION
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+
+      - name: Run Playwright tests
+        run: npm run test:e2e -- --reporter=html
+#
 #  deploy:
-#    needs: build
+#    needs: [build, e2e_tests, unit_and_component_tests]
+#    if: github.ref == 'refs/heads/main'
 #    runs-on: ubuntu-latest
+#
 #    permissions:
 #      pages: write
 #      id-token: write
@@ -62,6 +112,10 @@ jobs:
 #      url: ${{ steps.deployment.outputs.page_url }}
 #
 #    steps:
+#  - uses: actions/download-artifact@v2
+#  with:
+#    name: build
+#    path: build
 #      - name: Deploy
 #        id: deployment
 #        uses: actions/deploy-pages@v4

README.md

@@ -2,7 +2,7 @@
 
 Copyright 2024 [Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/)
 
-LD-Explorer is the _missing tool_ for exploring and experimenting with linked data resources directly in the browser.
+LD-Explorer is a prototype user interface built upon the [Comunica graph querying framework](https://comunica.dev/) that can be used for exploring linked data resources directly in the browser. We have found that this tool helps to better demonstrate the value and purpose of linked data to newcomers, and increases the speed at which experiments/ideas can be created and tested. We are open sourcing this software to fill what we believe is a software gap in the linked data linked data space and to hopefully encourage its growth into a valuable community tool.
 
 ## Development
 
@@ -37,4 +37,3 @@ This software is inner-source and contributions are welcome. See [Contributing.m
 
 Unless stated otherwise, the codebase is released under the [Apache2 License](https://www.apache.org/licenses/LICENSE-2.0). This covers both the codebase and any sample code in the documentation. The documentation/wiki is and available under the terms of the [Open Government License v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).
 
-© Crown copyright 2024