build(deps): bump jsonwebtoken from 8.5.1 to 9.0.0

.github/workflows/pr-review.yml

@@ -0,0 +1,85 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: PR Review
+
+on: [ pull_request, workflow_dispatch ]
+
+jobs:
+  build:
+    name: Build
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - name: Prepare environment 
+      run: |
+        docker run --name typeorm-postgres -p 5432:5432 -e POSTGRES_PASSWORD=password -e POSTGRES_DB=typescript_api -e POSTGRES_USER=typescript_user -d postgres
+        npm ci
+        npm run generate-config
+        npm run typeorm -- migration:run
+    - name: Build project
+      run: npm run build
+
+
+  test:
+    name: Run tests
+
+    needs: build
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js
+      uses: actions/setup-node@v3
+      with:
+        cache: 'npm'
+    - name: Prepare environment 
+      run: |
+        docker run --name typeorm-postgres -p 5432:5432 -e POSTGRES_PASSWORD=password -e POSTGRES_DB=typescript_api -e POSTGRES_USER=typescript_user -d postgres
+        npm ci
+        npm run generate-config
+        npm run typeorm -- migration:run
+    - name: Build project
+      run: npm run build
+    - name: Run tests
+      uses: mattallty/jest-github-action@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+
+  format:
+    name: Run formatter
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        repository: ${{ github.event.pull_request.head.repo.full_name }}
+        ref: ${{ github.event.pull_request.head.ref }}
+    - name: Use Node.js
+      uses: actions/setup-node@v3
+      with:
+        cache: 'npm'
+    - name: Prepare environment
+      run: npm ci
+    - name: Run formatter
+      run: npm run format
+    - name: Commit results
+      uses: EndBug/add-and-commit@v9
+      with:
+        message: 'style: run formatter'
+        default_author: github_actions

README.md

@@ -1,4 +1,4 @@
-# Typescript Example Project
+# devU API
 
 This is an API for the v4 autograder. The main purpose of this project is to act as an in-between for the containers doing the autograding, and the users submitting assignments.
 
@@ -9,7 +9,7 @@ This is an API for the v4 autograder. The main purpose of this project is to act
 
 For now the only reason we're including docker is to more easily control the development database. In the future we may very well dockerize the api itself for ease of development and deployment, but for now this writeup is expecting it to be running directly on your machine via node.
 
-## Running the project locally
+## Running the Project Locally
 
 ### Getting Everything Started
 
@@ -25,7 +25,7 @@ docker run \
   -d postgres
 ```
 
-Install all node dependancies. All of the database environment variables can change, and can be set as environment variables on your machine if you want to overwrite the defaults
+Install all node dependencies. All of the database environment variables can change, and can be set as environment variables on your machine if you want to overwrite the defaults
 
 ```
 npm install
@@ -37,7 +37,6 @@ Run the setup script to create local development auth keys. These are used in lo
 npm run generate-config
 ```
 
-
 Run the initial migrations to setup our DB schema
 
 ```
@@ -76,13 +75,13 @@ Use [Azure Data Studio](https://docs.microsoft.com/en-us/sql/azure-data-studio/d
 
 ### Local Auth Providers
 
-If you're looking for more information on how to setup auth for your developement environment, check out more info [here](./docs/localAuth.md)
+If you're looking for more information on how to setup auth for your development environment, check out more info [here](./docs/localAuth.md)
 
 ## Working in the Project
 
 This project is built using
 
-- [Typescript](https://www.typescriptlang.org/) - A superset of JavaScript. The language of the applciation
+- [Typescript](https://www.typescriptlang.org/) - A superset of JavaScript. The language of the application
 - [Express](https://expressjs.com/) - A Node REST framework.
 - [TypeORM](https://typeorm.io/#/) - A Typescript ORM (manages the DB and all DB calls)
 
@@ -101,7 +100,7 @@ In express, all of the functions added after the route's path are considered mid
 Express's middleware is always a function with three arguments
 
 ```typescript
-function middlwareName(req: Reques, res: Response, next: NextFunction)
+function middlewareName(req: Request, res: Response, next: NextFunction)
 ```
 
 Here's what you need to know:
@@ -130,7 +129,7 @@ Let's take this from the top
 - Controllers: deals with setting status codes, and directing to services. For the most part, controllers should be the last piece of middleware in the chain.
 - Services: Workhorse of the application. Deals with all major application logic and database calls
 
-The database models live outside of this control flow as they don't deal with any buisness logic. However services will use them to access the database. You can largely think of the models as a 1:1 map to database tables.
+The database models live outside of this control flow as they don't deal with any business logic. However services will use them to access the database. You can largely think of the models as a 1:1 map to database tables.
 
 ### Shared Modules
 
@@ -168,7 +167,7 @@ npm test
 
 Keep in mind that when testing, jest is looking for `*.test.ts` files, so be sure to include the `.test` portion in those filenames.
 
-If durring development, you want to only run a single test file (via command line), you can do so by adding a string to the end of the test command. That string will be used as a regex against the filename(s). So as an example, if we wanted to run all of the controller tests, you could do so by:
+If during development, you want to only run a single test file (via command line), you can do so by adding a string to the end of the test command. That string will be used as a regex against the filename(s). So as an example, if we wanted to run all of the controller tests, you could do so by:
 
 ```
 npm test "controller"
@@ -210,7 +209,7 @@ npm run typeorm -- migration:revert
 
 ### Configuration Options
 
-Most of the API's configuraiton options live in a file called `environment.ts`. That file is bootstrapped at startup using the [config library]https://www.npmjs.com/package/config), as well as some environment variables.
+Most of the API's configuration options live in a file called `environment.ts`. That file is bootstrapped at startup using the [config library](https://www.npmjs.com/package/config), as well as some environment variables.
 
 What this means for you (the developer) is that you can control certain api options via environment variables at runtime, or by using your `config/default.yml`. To see which `environment.ts` options support using environment variables directly, open that file and see which are using `process.env.*`; everything else should be configurable via your `default.yml`
 
@@ -236,7 +235,7 @@ import Routers
 import Utils
 ```
 
-The important thing here is once you get into the modules (models/ controllers/ routers/ etc), import them alphebetically with a single empty line inbetween them.
+The important thing here is once you get into the modules (models/ controllers/ routers/ etc), import them alphabetically with a single empty line in between them.
 
 ## Production Builds
 

docs/SCHEMA.md

@@ -0,0 +1,119 @@
+# Entities
+
+- [x] [User](#user)
+- [x] [Course](#course)
+- [x] [UserCourse](#usercourse)
+- [x] [Assignment](#assignment)
+- [x] [Submission](#submission)
+- [x] [AssignmentProblem](#assignmentproblem)
+- [ ] [SubmissionProblemScore](#submissionproblemscore)
+- [ ] [SubmissionScore](#submissionscore)
+- [ ] [AssignmentScore](#assignmentscore)
+- [ ] [CategoryScore](#categoryscore)
+- [ ] [Category](#category)
+- [ ] [CourseScore](#coursescore)
+
+# Entity Details
+
+### Generic Entity Attributes
+
+- id
+- createdAt
+- updatedAt
+- deletedAt
+
+### User
+
+_Student user for devu_
+
+- email: string
+- externalId: foreign_key
+- preferredName: string
+
+### Course
+
+- name: string
+- semester: string
+- number: string _ex: cse220_
+- startDate: ?
+- endDate: ?
+
+### UserCourse
+
+_Links a user to a course_
+
+- userId: foreign_key
+- courseId: foreign_key
+- level: ?
+- dropped: boolean
+
+### Assignment
+
+- courseId: foreign_key
+- name: string
+- startDate: ?
+- dueDate: ?
+- endDate: ?
+- gradingType: ?
+- categoryName: ?
+- description: string
+- maxFileSize: ?
+- maxSubmissions: ?
+- disableHandins: boolean
+
+### Submission
+
+- courseId: foreign_key
+- assignmentId: foreign_key
+- userId: foreign_key
+- content: ?
+- type: ?
+- submitterIp: ?
+- submittedBy: ?
+- orignalSubmissionId: ?
+
+### AssignmentProblem
+
+- assignmentId: foreign_key
+- problemName: ?
+- maxScore: ?
+
+**------ Everything above this line exists in the code. Everything below needs to be built ------**
+
+### SubmissionProblemScore
+
+- submissionId: foreign_key
+- assignmentProblemId: foreign_key
+- score: ?
+- feedback: ?
+- released: ?
+
+### SubmissionScore
+
+- submissionId: foreign_key
+- score: ?
+- feedback: ?
+- released: ?
+
+### AssignmentScore
+
+- assignmentId: foreign_key
+- userId: foreign_key
+- score: ?
+
+### CategoryScore
+
+- categoryId: foreign_key
+- userId: foreign_key
+- _missing attributes_
+
+### Category
+
+- courseId: foreign_key
+- _missing attributes_
+
+### CourseScore
+
+- courseId: foreign_key
+- userId: foreign_key
+- _missing attributes_