Merge pull request #672 from UTDNebula/develop

Sync with develop

.env.example

@@ -1,39 +1,74 @@
-# Prisma
-# In production, DATABASE_URL uses a connection pooler, so we need to separately set DIRECT_DATABASE_URL because Prisma Migrate requires a direct connection to the database. 
-# DIRECT_DATABASE_URL does not need to be set locally if you are not running database migrations.
-# See https://www.prisma.io/docs/guides/performance-and-optimization/connection-management/configure-pg-bouncer#prisma-migrate-and-pgbouncer-workaround for more details
+########## Prisma ##########
+## Required in all environments.
+##
+## In production, DATABASE_URL uses a connection pooler, so we need to separately set DIRECT_DATABASE_URL 
+## because Prisma Migrate requires a direct connection to the database. 
+## See https://www.prisma.io/docs/guides/performance-and-optimization/connection-management/configure-pg-bouncer#prisma-migrate-and-pgbouncer-workaround for more details
+##
+## For development, set DIRECT_DATABASE_URL to the same value as DATABASE_URL.
 DATABASE_URL=
 DIRECT_DATABASE_URL=
 PLATFORM_DATABASE_URL=
 
-# Next Auth
+
+########## NextAuth ##########
+## Required in all environments.
+##
+## NEXTAUTH_URL is the base URL of the website
+## (e.g. if running locally on port 3000, NEXTAUTH_URL=http://localhost:3000).
 NEXTAUTH_URL=
 NEXTAUTH_SECRET=
+
+
+########## Provider's ##########
+## Only one provider required for development.
+## All providers required in produciton. 
+
 # Google Provider
 GOOGLE_CLIENT_ID=
 GOOGLE_CLIENT_SECRET=
+
 # Next Auth Discord Provider
 DISCORD_CLIENT_ID=
-DISCORD_CLIENT_SECRET=-
-#Facebook provider
+DISCORD_CLIENT_SECRET=
+
+# Facebook provider
 FACEBOOK_CLIENT_ID=
 FACEBOOK_CLIENT_SECRET=
 
+
+########## Nodemailer ##########
+## Only required in production.
+
 # Email Server
 EMAIL_SERVER_HOST=
 EMAIL_SERVER_PORT=
 EMAIL_SERVER_USER=
 EMAIL_SERVER_PASSWORD=
 EMAIL_FROM=
 
-# DEGREE VALIDATOR
-VALIDATOR=
 
+########## Degree validator ##########
+## Required in all environments.
+NEXT_PUBLIC_VALIDATOR=
+
+
+########## Node ##########
+## Should be set to "development" in development and "production" in production.
 NODE_ENV=
 
-# Umami: self-hosted analytics service
+
+########## Umami ##########
+## Umami: self-hosted analytics service
+## Required only in production.
 NEXT_PUBLIC_UMAMI_URL=
 NEXT_PUBLIC_UMAMI_WEBSITE_ID=
 
+
+########## Sentry ##########
+## Sentry: error tracking service
+## Not required in any environments.
+## If not set, defaults to "https://edb9e327f9024e7599eae859bad9be47@o4504918397353984.ingest.sentry.io/4504924302409728"
+## at runtime.
 NEXT_PUBLIC_SENTRY_DSN=
 SENTRY_DSN=

.github/workflows/build.yml

@@ -76,7 +76,7 @@ jobs:
           EMAIL_FROM: [email protected]
 
           # DEGREE VALIDATOR
-          VALIDATOR: http://localhost:5000
+          NEXT_PUBLIC_VALIDATOR: http://localhost:5000
 
           NODE_ENV: production
           VERCEL_ENV: preview

.github/workflows/delete-neon-branch.yml

@@ -9,7 +9,7 @@ on:
     types:
       - closed
     paths-ignore:
-      - 'validator/**'
+      - '*.md'
   workflow_dispatch:
 
 jobs:

.github/workflows/deploy-preview.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - 'develop'
     paths-ignore:
-      - 'validator/**'
+      - '*.md'
   workflow_dispatch:
 
 env:

.github/workflows/tests.yml

@@ -7,7 +7,7 @@ on:
       - 'develop'
       - 'main'
     paths-ignore:
-      - 'validator/**'
+      - '*.md'
 
 jobs:
   integration-tests:
@@ -60,7 +60,7 @@ jobs:
       EMAIL_FROM: [email protected]
 
       # DEGREE VALIDATOR
-      VALIDATOR: ${{ secrets.VALIDATOR }}
+      NEXT_PUBLIC_VALIDATOR: http://127.0.0.1:5000
 
       NODE_ENV: test
 
@@ -72,6 +72,17 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
+      - name: Setup Python3.11
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Start validator server
+        working-directory: validator
+        run: |
+          pip install -r requirements.txt
+          flask --app api run &
+
       - name: Start MongoDB
         uses: supercharge/[email protected]
         with:

.github/workflows/validator_test.yml

@@ -19,7 +19,7 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.11'
 
       - name: Install dependencies
         run: |

.gitignore

@@ -38,6 +38,9 @@ yarn-error.log*
 # Vercel
 .vercel
 
+# virtual environments
+.venv/
+
 .eslintcache
 .firebaserc
 *.cache

CODEOWNERS

@@ -1,5 +1,14 @@
-# Request project lead by default
-* @akevinge
+# Request lead for file changes in root and workflows.
+/* @akevinge
+/.github/**/* @akevinge
+
+# Request Planner PR Reviewers team for changes in to the following root directories.
+/.vscode/ @UTDNebula/pr-reviewers
+/cypress/ @UTDNebula/pr-reviewers
+/docs/ @UTDNebula/pr-reviewers
+/prisma/ @UTDNebula/pr-reviewers
+/public/ @UTDNebula/pr-reviewers
+/src/ @UTDNebula/pr-reviewers
+/tests/ @UTDNebula/pr-reviewers
+/validator/ @UTDNebula/pr-reviewers
 
-# Request all Project Nebula Maintainers to review other pull requests
-src/**/* @UTDNebula/Planner-Maintainers