Update report

.devcontainer/Dockerfile

@@ -0,0 +1,12 @@
+FROM mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye
+
+# Update and install system dependencies
+RUN apt-get update && apt-get install -y \
+    asciidoctor \
+    graphviz \
+    openjdk-17-jdk \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install Asciidoctor PDF and Asciidoctor Diagram
+RUN gem install asciidoctor-pdf --pre asciidoctor-diagram coderay

.devcontainer/devcontainer.json

@@ -3,7 +3,8 @@
 {
 	"name": "Node.js & TypeScript",
 	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
+	"dockerFile": "Dockerfile",
+	"context": "..",
 	"customizations": {
 		"vscode": {
 			"extensions": [

.gcloudignore

@@ -12,6 +12,7 @@
 # below:
 .git
 .gitignore
+.github/
 
 # Node.js dependencies:
 node_modules/
@@ -33,9 +34,7 @@ Dockerfile
 
 # Exclude local development environment files
 .env
-.env.local
-.env.development
-.env.test
+
 
 # Exclude TypeScript source maps and other build artifacts
 *.map

.vscode/settings.json

@@ -7,7 +7,13 @@
         }
     ],
     "cSpell.words": [
+        "enduml",
+        "hardbreaks",
         "nessicarily",
-        "openapi"
+        "Nonfunctional",
+        "openapi",
+        "Pikho",
+        "Serhiy",
+        "startuml"
     ]
 }

README.md

@@ -0,0 +1,16 @@
+# Scitt Inspired Transparency Service 
+## Abstract
+This repository contains the code for my final year project at Birkbeck university. The project is inspired emerging ecosystem of transparency and trust services based on the IETF SCITT standard. 
+It serves as a demonstration of how I can develop the service in typescript and deploy it to the cloud, rather than an implementation of the SCITT standard itself (which at the time of writing is still in draft form). 
+
+## Running the project
+
+The project in its current state it self contained and tests can be run locally.
+
+1. Make sure Node.js is installed
+2. Clone the repository
+3. inside the project directory run `npm install`
+4. run `npm test` to run the tests - This will use jest and mongodb-memory-server to run the tests
+5. run `npm start` to start the service - you will need to provide a valid mongodb connection string in the .env file
+
+

openapi/projects.yaml

@@ -2,13 +2,6 @@ openapi: 3.0.0
 info:
   title: Projects API
   version: 1.0.0
-tags:
-  - name: projectCollaborators_other
-    x-displayName: other
-  - name: projects_other
-    x-displayName: other
-  - name: events_other
-    x-displayName: other
 paths:
   /Projects:
     post:
@@ -32,8 +25,6 @@ paths:
           description: Validation error
         '403':
           description: JWT authentication required
-      tags:
-        - projects_other
     get:
       summary: View all projects
       security:
@@ -49,8 +40,6 @@ paths:
                   $ref: './schemas/Response/ProjectResponse.yaml'
         '403':
           description: JWT authentication required
-      tags:
-        - projects_other
   /Projects/{projectId}:
     patch:
       summary: Updating a project
@@ -82,8 +71,6 @@ paths:
           description: JWT authentication required
         '404':
           description: Project ID not found
-      tags:
-        - projects_other
     get:
       summary: Project Overview
       security:
@@ -115,8 +102,6 @@ paths:
           description: JWT authentication required
         '404':
           description: Project ID not found
-      tags:
-        - projects_other
   /Projects/{projectId}/events:
     post:
       summary: Create an event on a project
@@ -148,8 +133,6 @@ paths:
           description: JWT authentication required
         '404':
           description: Project ID not found
-      tags:
-        - events_other
     get:
       summary: View all Events on a project
       security:
@@ -174,8 +157,6 @@ paths:
           description: JWT authentication required
         '404':
           description: Project ID not found
-      tags:
-        - events_other
   /Projects/{projectId}/events/{eventId}:
     get:
       summary: View Single Event
@@ -205,8 +186,6 @@ paths:
           description: JWT authentication required
         '404':
           description: Project ID or Event ID not found
-      tags:
-        - events_other
 components:
   securitySchemes:
     jwtAuth:

package.json

@@ -6,6 +6,7 @@
   "scripts": {
     "test": "jest",
     "generate": "npx openapi-typescript",
+    "report": "asciidoctor-pdf -r asciidoctor-diagram -linkcss report/pikho-serhiy-13108607.adoc ",
     "build": "npx tsc",
     "start": "node ./build/app/server.js",
     "dev": "concurrently \"npx tsc --watch\" \"nodemon --inspect -q ./build/app/server.js\"",