Navigation Overhaul + Homepage

.env.example

@@ -1,26 +1,40 @@
 # NB: These are _not_ prefixed with NEXT_PUBLIC because we don't want their values to be sewn into the Docker image
 # Base configuration
-DATABASE_URL="postgresql://postgres:postgres@localhost:5432/calendar_2023"
+DATABASE_URL="postgresql://postgres:postgres@localhost:5432/internal_site"
 PUBLIC_URL=http://localhost:3000
 SESSION_SECRET=             # A random string, in production should be a secure secret e.g. `openssl rand -base64 32`
 
 # Google login configuration
 GOOGLE_CLIENT_ID=
-GOOGLE_PERMITTED_DOMAINS=york.ac.uk
+GOOGLE_PERMITTED_DOMAINS=york.ac.uk,ystv.co.uk
 
+
+# Needed for youtube integration, optional otherwise. This is *not* the client secret!
+GOOGLE_API_KEY=
 # AdamRMS configuration
 ADAMRMS_EMAIL=
 ADAMRMS_PASSWORD=
 ADAMRMS_BASE=
 ADAMRMS_PROJECT_TYPE_ID=
 
+
 # Slack configuration
 SLACK_ENABLED=false
+SESSION_SECRET=
+COOKIE_DOMAIN=localhost
+SESSION_SECRET=
+SLACK_ENABLED=
 SLACK_BOT_TOKEN=
 SLACK_APP_TOKEN=
 SLACK_SIGNING_SECRET=
 SLACK_CLIENT_ID=
 SLACK_CLIENT_SECRET=
-SLACK_TEAM_ID=              # Should be set only if the slack integration is used across multiple workspaces
-SLACK_USER_FEEDBACK_CHANNEL=
-SENTRY_PROJECT_ID=
+# SLACK_BOT_TOKEN=
+# SLACK_APP_TOKEN=
+# SLACK_SIGNING_SECRET=
+# SLACK_CLIENT_ID=
+# SLACK_CLIENT_SECRET=
+# Should be set if the slack integration is used across multiple workspaces
+SLACK_TEAM_ID=
+# Use https://www.streamweasels.com/tools/youtube-channel-id-and-user-id-convertor/ to convert
+YOUTUBE_CHANNEL_ID=UCwViVJcFiwBSDmzhaHiagqw

.envrc

@@ -0,0 +1 @@
+use flake

.eslintrc.json

@@ -2,7 +2,8 @@
   "extends": [
     "next/core-web-vitals",
     "prettier",
-    "plugin:storybook/recommended"
+    "plugin:storybook/recommended",
+    "plugin:@tanstack/query/recommended"
   ],
   "plugins": ["@typescript-eslint"],
   "rules": {

.github/pull_request_template.md

@@ -0,0 +1,17 @@
+https://linear.app/ystv/issue/INT-XXX <!-- fill this in, or remove if there isn't one -->
+
+## What
+
+<!-- What does this PR do? One sentence if possible. -->
+
+## Why
+
+<!-- How does this PR improve YSTV members' lives? -->
+
+## How
+
+<!-- Is there anything noteworthy about how you implemented it? Something for the reviewer to be aware of? -->
+
+## Testing
+
+<!-- Give evidence that it works, to save your reviewer's time. Talk about how you tested it. Include screenshots. -->

.gitignore

@@ -4,6 +4,7 @@
 /node_modules
 /.pnp
 .pnp.js
+/.direnv
 
 # testing
 /coverage
@@ -48,4 +49,6 @@ next-env.d.ts
 # Sentry Auth Token
 .sentryclirc
 
-certificates
+certificates
+# Sentry Config File
+.env.sentry-build-plugin

Dockerfile

@@ -4,19 +4,22 @@ FROM node:20-bookworm-slim AS base
 RUN apt-get update -y && apt-get install -y ca-certificates git openssl
 
 FROM base AS build
+RUN apt-get update -y && apt-get install -y build-essential python3
 WORKDIR /app
 COPY ./.yarn/ .yarn/
 COPY . /app/
-RUN --mount=type=cache,id=calendar2023-yarn,target=.yarn/cache yarn install --immutable --inline-builds
+RUN --mount=type=cache,id=internal-site-yarn,target=.yarn/cache yarn install --immutable --inline-builds
 
 ENV NODE_ENV=production
 ARG GIT_REV
 ENV GIT_REV=$GIT_REV
-ARG SENTRY_AUTH_TOKEN
-ENV SENTRY_AUTH_TOKEN=$SENTRY_AUTH_TOKEN
 ARG VERSION
 ENV VERSION=$VERSION
-RUN SKIP_ENV_VALIDATION=1 PUBLIC_URL="http://localhost:3000" yarn run build
+RUN --mount=type=secret,id=sentry-auth-token \
+  SENTRY_AUTH_TOKEN=$(cat /run/secrets/sentry-auth-token) \
+  SKIP_ENV_VALIDATION=1 \
+  PUBLIC_URL="http://localhost:3000" \
+  yarn run build
 
 FROM base
 COPY --from=build /app/dist /app/dist

Jenkinsfile

@@ -3,7 +3,10 @@
 def imageTag = ''
 pipeline {
   agent {
-    label 'docker'
+    node {
+      label 'docker && ramdisk'
+      customWorkspace '/mnt/ramdisk/build/workspace/internal-site'
+    }
   }
 
   environment {
@@ -25,14 +28,14 @@ pipeline {
     }
     stage('Build Images') {
       environment {
-        SENTRY_AUTH_TOKEN = credentials('calendar-sentry-auth-token')
+        SENTRY_AUTH_TOKEN = credentials('internal-site-sentry-auth-token')
       }
       steps {
         sh """docker build \\
           --build-arg GIT_REV=${env.GIT_COMMIT} \\
           --build-arg VERSION=${env.TAG_NAME ?: 'v0.0.0'} \\
-          --build-arg SENTRY_AUTH_TOKEN=\$SENTRY_AUTH_TOKEN \\
-          -t registry.comp.ystv.co.uk/ystv/calendar2023:${imageTag}\\
+          --secret id=sentry-auth-token,env=SENTRY_AUTH_TOKEN \\
+          -t registry.comp.ystv.co.uk/ystv/internal-site:${imageTag}\\
           .
         """
       }
@@ -47,7 +50,7 @@ pipeline {
         }
       }
       steps {
-        dockerPush image: 'registry.comp.ystv.co.uk/ystv/calendar2023', tag: imageTag
+        dockerPush image: 'registry.comp.ystv.co.uk/ystv/internal-site', tag: imageTag
       }
     }
 
@@ -56,7 +59,7 @@ pipeline {
         changeRequest target: 'main'
       }
       steps {
-        deployPreview action: 'deploy', job: 'calendar-preview', urlSuffix: 'internal.dev.ystv.co.uk'
+        deployPreview action: 'deploy', job: 'internal-site-preview', urlSuffix: 'internal.dev.ystv.co.uk'
       }
     }
 
@@ -66,11 +69,12 @@ pipeline {
       }
       steps {
         build job: 'Deploy Nomad Job', parameters: [
-          string(name: 'JOB_FILE', value: 'calendar-dev.nomad'),
-          text(name: 'TAG_REPLACEMENTS', value: "registry.comp.ystv.co.uk/ystv/calendar2023:${imageTag}")
+          string(name: 'JOB_FILE', value: 'internal-site-dev.nomad'),
+          text(name: 'TAG_REPLACEMENTS', value: "registry.comp.ystv.co.uk/ystv/internal-site:${imageTag}")
         ], wait: true
         deployPreview action: 'cleanup'
-        sh "nomad alloc exec -task calendar-dev -job calendar-dev npx -y prisma migrate deploy --schema lib/db/schema.prisma"
+        deployPreview action: 'cleanupMerge'
+        sh "nomad alloc exec -task internal-site-dev -job internal-site-dev npx -y prisma migrate deploy --schema lib/db/schema.prisma"
       }
     }
 
@@ -81,10 +85,10 @@ pipeline {
       }
       steps {
         build job: 'Deploy Nomad Job', parameters: [
-          string(name: 'JOB_FILE', value: 'calendar-prod.nomad'),
-          text(name: 'TAG_REPLACEMENTS', value: "registry.comp.ystv.co.uk/ystv/calendar2023:${imageTag}")
+          string(name: 'JOB_FILE', value: 'internal-site-prod.nomad'),
+          text(name: 'TAG_REPLACEMENTS', value: "registry.comp.ystv.co.uk/ystv/internal-site:${imageTag}")
         ], wait: true
-        sh "nomad alloc exec -task calendar-prod -job calendar-prod npx -y prisma migrate deploy --schema lib/db/schema.prisma"
+        sh "nomad alloc exec -task internal-site-prod -job internal-site-prod npx -y prisma migrate deploy --schema lib/db/schema.prisma"
       }
     }
   }

README.md

@@ -1,11 +1,11 @@
-# YSTV Calendar
+# YSTV Internal Site
 
 This is the repo for https://internal.ystv.co.uk.
 Formerly known as `experimental-hypothetical-new-internal-site-idea`.
 
 ## Getting Started
 
-To set up a local copy of the new calendar, you will need
+To set up a local copy of the new internal site, you will need
 
 - Node.js (18 or later) - https://nodejs.org/en/download
 - Yarn - once you have Node installed, run `corepack enable`
@@ -31,7 +31,7 @@ You will also need to set up the following:
 
 ### Postgres Database
 
-Once you have PostgreSQL installed, run `createdb calendar_2023`.
+Once you have PostgreSQL installed, run `createdb internal_site`.
 
 Now run `yarn prisma db push` to set up the database tables.
 If you get a permissions error, check your PostgreSQL authentication settings - you should have a `local all all peer` line in your pg_hba.conf.
@@ -80,13 +80,21 @@ Open [http://localhost:3000](http://localhost:3000) or [https://localhost:3000](
 
 To get admin permissions, sign in once with Google, then run `yarn do promoteUser <your email>`.
 
+## Development
+
+There are some docs written for developing specific features but otherwise looking at the code and the [Next.js documentation](https://nextjs.org/docs) is the best place to get started.
+
+Feature specific docs:
+
+- [Socket.io communication](/docs/development/implementing_socket_io.md)
+
 ## Structure
 
 - app/ - pages
 - features/ - business logic functinality
 - lib/ - low level utilities (auth, db, etc.)
 - server/ - custom server that handles socket.io communication
 
-## Development
+## Contributing
 
-We use [Linear](https://linear.app/ystv) to track issues - to access it, sign in with your @ystv.co.uk Google account (ask a Computing Team member if you don't have one).
+Some documentation about how to contribute and some standards to follow is available [here](/docs/contributing.md)

app/(authenticated)/admin/layout.tsx

@@ -0,0 +1,15 @@
+import ErrorPage from "@/components/ErrorPage";
+import { hasPermission } from "@/lib/auth/server";
+import { notFound } from "next/navigation";
+
+export default async function AuthenticatedLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  if (await hasPermission("Admin.Positions", "Admin.Roles", "Admin.Users")) {
+    return <>{children}</>;
+  } else {
+    return <ErrorPage code={403} message="Forbidden" />;
+  }
+}

app/(authenticated)/admin/page.tsx

@@ -0,0 +1,26 @@
+import { PageInfo } from "@/components/PageInfo";
+import { Button, Card, Stack } from "@mantine/core";
+import Link from "next/link";
+
+export const dynamic = "force-dynamic";
+
+export default function AdminPage() {
+  return (
+    <>
+      <PageInfo title="Admin" />
+      <Card>
+        <Stack>
+          <Link href={"/admin/users"}>
+            <Button variant="default">Users</Button>
+          </Link>
+          <Link href={"/admin/positions"}>
+            <Button variant="default">Crew Positions</Button>
+          </Link>
+          <Link href={"/admin/roles"}>
+            <Button variant="default">Roles</Button>
+          </Link>
+        </Stack>
+      </Card>
+    </>
+  );
+}