Merge pull request #21 from utat-ss/dev

Release MVP 1.0

.devcontainer/devcontainer.json

@@ -0,0 +1,14 @@
+// For format details, see https://aka.ms/devcontainer.json
+{
+	"image": "mcr.microsoft.com/devcontainers/universal:2",
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"Angular.ng-template",
+				"Orta.vscode-jest",
+				"nrwl.angular-console",
+				"AlexShen.classdiagram-ts"
+			]
+		}
+	}
+}

.github/workflows/pipeline.yml

@@ -0,0 +1,59 @@
+name: Pipeline
+on: [push, pull_request]
+jobs:
+  build-client:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./client
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npx ng build
+
+  test-client:
+    runs-on: ubuntu-latest
+    needs: build-client
+    defaults:
+      run:
+        working-directory: ./client
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Install client dependencies
+        run: npm ci
+
+      - name: Test
+        run: npx ng test
+
+  test-server:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./server
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Install server dependencies
+        run: npm ci
+
+      - name: Test
+        env:
+          NOTION_TOKEN: ${{ secrets.NOTION_TOKEN }}
+          NOTION_REQUIREMENTS_DB_ID: "b9c7195bd9fa414a97ee704f503a0e9f"
+          NOTION_REQUIREMENT_QUALIFIERS_DB_ID: "73c9d422a5204bcc9245a752413353e8"
+          NOTION_REQUIREMENT_TYPES_DB_ID: "2cedac620d554fb0ad17abcb2388f842"
+          NOTION_TEST_PLANS_DB_ID: "9e32b247f1f24362b471481e475132dc"
+          NOTION_SYSTEM_ARCHITECTURE_DB_ID: "aa7abed08ca749f685d8266b6ede20ce"
+          NOTION_TRADES_DB_ID: "ab99520cf6c947b0a57dc9fe75bff34c"
+          NOTION_TEAMS_DB_ID: "2b64b90381df4cc2a25a8e7e32456d16"
+          NOTION_MISSIONS_DB_ID: "f449b66490e74911816ede6ac36b0867"
+        run: npm test

.gitignore

@@ -1,42 +1,7 @@
-# See http://help.github.com/ignore-files/ for more about ignoring files.
-
-# Compiled output
-/dist
-/tmp
-/out-tsc
-/bazel-out
-
-# Node
-/node_modules
-npm-debug.log
-yarn-error.log
-
-# IDEs and editors
-.idea/
-.project
-.classpath
-.c9/
-*.launch
-.settings/
-*.sublime-workspace
-
 # Visual Studio Code
 .vscode/*
 !.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
-.history/*
-
-# Miscellaneous
-/.angular/cache
-.sass-cache/
-/connect.lock
-/coverage
-/libpeerconnection.log
-testem.log
-/typings
-
-# System files
-.DS_Store
-Thumbs.db
+.history/*

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "printWidth": 88,
+  "tabWidth": 4,
+  "useTabs": false,
+  "semi": false,
+  "singleQuote": false
+}

.vscode/extensions.json

@@ -2,6 +2,8 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=827846
   "recommendations": [
     "angular.ng-template",
-    "nrwl.angular-console"
+    "nrwl.angular-console",
+    "orta.vscode-jest",
+    "alexshen.classdiagram-ts"
   ]
 }

.vscode/launch.json

@@ -1,20 +1,26 @@
 {
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "ng serve",
+      "name": "client: ng serve",
       "type": "pwa-chrome",
       "request": "launch",
       "preLaunchTask": "npm: start",
       "url": "http://localhost:4200/"
     },
     {
-      "name": "ng test",
+      "name": "client: ng test",
       "type": "chrome",
       "request": "launch",
       "preLaunchTask": "npm: test",
       "url": "http://localhost:9876/debug.html"
+    },
+    {
+      "type": "node-terminal",
+      "name": "client: npm run start",
+      "request": "launch",
+      "command": "npm run start",
+      "cwd": "${workspaceFolder}/server"
     }
   ]
-}
+}

.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

README.md

@@ -1,7 +1,22 @@
-# tree-visualizer
+[![Pipeline](https://github.com/utat-ss/tree-visualizer/actions/workflows/pipeline.yml/badge.svg)](https://github.com/utat-ss/tree-visualizer/actions/workflows/pipeline.yml)
 
-A tree-like Notion database visualizer
+<img src="client/src/assets/treeviz-logo.png" height="128">
 
----
+# TreeViz
+An interactive requirements engineering tool. TreeViz makes working with requirement models more approachable by visualizing parent and child relationships as a graph. It connects to the team's [requirements database](https://www.notion.so/utat-ss/b9c7195bd9fa414a97ee704f503a0e9f?v=0f0b8595c5a943f5b01190c34206415b&pvs=4).
 
-_Note: active development is currently occuring in the [`dev` branch](https://github.com/utat-ss/tree-visualizer/tree/dev)_
+Built by the [University of Toronto Aerospace Team](https://www.utat.ca/space-systems):milky_way:.
+
+<img src="client/src/assets/utat-logo.png" height="64">
+
+# Usage
+1. Connect to the [UTAT VPN](https://www.notion.so/utat-ss/OpenVPN-db39f3bb05ab470688e540b9827473f7?pvs=4)
+1. Navigate to [https://treeviz.in.utat.ca/](https://treeviz.in.utat.ca/) in your browser
+
+See Notion [page](https://www.notion.so/utat-ss/TreeViz-78c65cf8e7af4b1ba30fc42d1922bc95?pvs=4)
+
+# Development
+
+## Setup
+1. Install [Node](https://nodejs.org/en)
+1. Run `npm install` within both the client and server folders

client/.gitignore

@@ -0,0 +1,42 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# Compiled output
+/dist
+/tmp
+/out-tsc
+/bazel-out
+
+# Node
+/node_modules
+npm-debug.log
+yarn-error.log
+
+# IDEs and editors
+.idea/
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# Visual Studio Code
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history/*
+
+# Miscellaneous
+/.angular/cache
+.sass-cache/
+/connect.lock
+/coverage
+/libpeerconnection.log
+testem.log
+/typings
+
+# System files
+.DS_Store
+Thumbs.db

client/Dockerfile

@@ -0,0 +1,22 @@
+
+## Based on https://nodejs.org/en/docs/guides/nodejs-docker-webapp/ ##
+
+FROM node:16
+
+# Create app dir
+WORKDIR /usr/src/app
+
+# Install app dependencies
+# A wildcard is used to ensure both package.json AND package-lock.json are copied
+# where available (npm@5+)
+COPY package*.json ./
+
+RUN npm ci --legacy-peer-deps
+# If you are building your code for production
+# RUN npm ci --only=production
+
+# Bundle app source
+COPY . .
+
+EXPOSE 4200
+CMD [ "npm", "run", "start:docker" ]

client/README.md

@@ -0,0 +1,27 @@
+# TreeVisualizer
+
+This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 15.0.3.
+
+## Development server
+
+Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
+
+## Code scaffolding
+
+Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+
+## Build
+
+Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
+
+## Running unit tests
+
+Run `ng test` to execute the unit tests via Jest.
+
+## Running end-to-end tests
+
+Cypress is not yet configured.
+
+## Further help
+
+To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.

angular.json → client/angular.json

@@ -40,8 +40,8 @@
               "budgets": [
                 {
                   "type": "initial",
-                  "maximumWarning": "500kb",
-                  "maximumError": "1mb"
+                  "maximumWarning": "1.5mb",
+                  "maximumError": "2mb"
                 },
                 {
                   "type": "anyComponentStyle",
@@ -57,7 +57,13 @@
               "vendorChunk": true,
               "extractLicenses": false,
               "sourceMap": true,
-              "namedChunks": true
+              "namedChunks": true,
+              "fileReplacements": [
+                {
+                  "replace": "src/environments/environment.ts",
+                  "with": "src/environments/environment.development.ts"
+                }
+              ]
             }
           },
           "defaultConfiguration": "production"
@@ -81,24 +87,8 @@
           }
         },
         "test": {
-          "builder": "@angular-devkit/build-angular:karma",
-          "options": {
-            "polyfills": [
-              "zone.js",
-              "zone.js/testing"
-            ],
-            "tsConfig": "tsconfig.spec.json",
-            "inlineStyleLanguage": "sass",
-            "assets": [
-              "src/favicon.ico",
-              "src/assets"
-            ],
-            "styles": [
-              "@angular/material/prebuilt-themes/indigo-pink.css",
-              "src/styles.sass"
-            ],
-            "scripts": []
-          }
+          "builder": "@angular-builders/jest:run",
+          "options": {}
         },
         "storybook": {
           "builder": "@storybook/angular:start-storybook",
@@ -119,4 +109,4 @@
   "cli": {
     "analytics": "464e1257-2b72-4c93-8be7-9499846af532"
   }
-}
+}