Readme Magazine

src/database/prisma/migrations/20250203201909_readme_magazine/migration.sql

@@ -0,0 +1,13 @@
+-- CreateTable
+CREATE TABLE "readme" (
+    "id" UUID NOT NULL DEFAULT gen_random_uuid(),
+    "title" TEXT NOT NULL,
+    "url" TEXT NOT NULL,
+    "created_at" TIMESTAMPTZ(6) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMPTZ(6) NOT NULL,
+    "year" INTEGER NOT NULL,
+    "number" INTEGER NOT NULL,
+    "published_at" TIMESTAMPTZ(6),
+
+    CONSTRAINT "readme_pkey" PRIMARY KEY ("id")
+);

src/database/prisma/schema.prisma

@@ -1124,4 +1124,18 @@ model ExpenseItem {
     signedAt DateTime?
 
     @@map("expense_items")
+}
+
+/// @@allow('read', true)
+model Readme {
+    id String @id() @default(dbgenerated("gen_random_uuid()")) @db.Uuid()
+    title String
+    url String
+    createdAt DateTime @default(now()) @map("created_at") @db.Timestamptz(6)
+    updatedAt DateTime @map("updated_at") @db.Timestamptz(6)
+    year Int
+    number Int
+    publishedAt DateTime? @map("published_at") @db.Timestamptz(6)
+
+    @@map("readme")
 }

src/database/schema.zmodel

@@ -1230,3 +1230,17 @@ model ExpenseItem {
 
   @@map("expense_items")
 }
+
+model Readme {
+  id          String    @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
+  title       String
+  url         String
+  createdAt   DateTime  @default(now()) @map("created_at") @db.Timestamptz(6)
+  updatedAt   DateTime  @map("updated_at") @db.Timestamptz(6)
+  year        Int
+  number      Int
+  publishedAt DateTime? @map("published_at") @db.Timestamptz(6)
+
+  @@map("readme")
+  @@allow("read", true)
+}

src/database/seed/.snaplet/dataModel.json

@@ -8328,6 +8328,134 @@
         }
       ]
     },
+    "readme": {
+      "id": "public.readme",
+      "schemaName": "public",
+      "tableName": "readme",
+      "fields": [
+        {
+          "id": "public.readme.id",
+          "name": "id",
+          "columnName": "id",
+          "type": "uuid",
+          "isRequired": true,
+          "kind": "scalar",
+          "isList": false,
+          "isGenerated": false,
+          "sequence": false,
+          "hasDefaultValue": true,
+          "isId": true,
+          "maxLength": null
+        },
+        {
+          "id": "public.readme.title",
+          "name": "title",
+          "columnName": "title",
+          "type": "text",
+          "isRequired": true,
+          "kind": "scalar",
+          "isList": false,
+          "isGenerated": false,
+          "sequence": false,
+          "hasDefaultValue": false,
+          "isId": false,
+          "maxLength": null
+        },
+        {
+          "id": "public.readme.url",
+          "name": "url",
+          "columnName": "url",
+          "type": "text",
+          "isRequired": true,
+          "kind": "scalar",
+          "isList": false,
+          "isGenerated": false,
+          "sequence": false,
+          "hasDefaultValue": false,
+          "isId": false,
+          "maxLength": null
+        },
+        {
+          "id": "public.readme.created_at",
+          "name": "created_at",
+          "columnName": "created_at",
+          "type": "timestamptz",
+          "isRequired": true,
+          "kind": "scalar",
+          "isList": false,
+          "isGenerated": false,
+          "sequence": false,
+          "hasDefaultValue": true,
+          "isId": false,
+          "maxLength": null
+        },
+        {
+          "id": "public.readme.updated_at",
+          "name": "updated_at",
+          "columnName": "updated_at",
+          "type": "timestamptz",
+          "isRequired": true,
+          "kind": "scalar",
+          "isList": false,
+          "isGenerated": false,
+          "sequence": false,
+          "hasDefaultValue": false,
+          "isId": false,
+          "maxLength": null
+        },
+        {
+          "id": "public.readme.year",
+          "name": "year",
+          "columnName": "year",
+          "type": "int4",
+          "isRequired": true,
+          "kind": "scalar",
+          "isList": false,
+          "isGenerated": false,
+          "sequence": false,
+          "hasDefaultValue": false,
+          "isId": false,
+          "maxLength": null
+        },
+        {
+          "id": "public.readme.number",
+          "name": "number",
+          "columnName": "number",
+          "type": "int4",
+          "isRequired": true,
+          "kind": "scalar",
+          "isList": false,
+          "isGenerated": false,
+          "sequence": false,
+          "hasDefaultValue": false,
+          "isId": false,
+          "maxLength": null
+        },
+        {
+          "id": "public.readme.published_at",
+          "name": "published_at",
+          "columnName": "published_at",
+          "type": "timestamptz",
+          "isRequired": false,
+          "kind": "scalar",
+          "isList": false,
+          "isGenerated": false,
+          "sequence": false,
+          "hasDefaultValue": false,
+          "isId": false,
+          "maxLength": null
+        }
+      ],
+      "uniqueConstraints": [
+        {
+          "name": "readme_pkey",
+          "fields": [
+            "id"
+          ],
+          "nullNotDistinct": false
+        }
+      ]
+    },
     "shoppable": {
       "id": "public.shoppable",
       "schemaName": "public",

src/database/seed/data.ts

@@ -305,4 +305,13 @@ export const models: SeedClientOptions["models"] = {
       color: () => faker.internet.color(),
     },
   },
+  readme: {
+    data: {
+      title: `README #${faker.number.int({ min: 1, max: 5 })}`,
+      url: "https://publuu.com/flip-book/782891/1741481/page/1?embed",
+      publishedAt: () => faker.date.past(),
+      year: () => faker.date.recent().getFullYear(),
+      number: () => faker.number.int({ min: 1, max: 5 }),
+    },
+  },
 };

src/database/seed/main.ts

@@ -75,6 +75,8 @@ const main = async () => {
 
   await seed.election((x) => x(5));
 
+  await seed.readme((x) => x(5));
+
   process.exit();
 };
 

src/lib/components/home/Readme.svelte

@@ -0,0 +1,15 @@
+<script lang="ts">
+  import type { Readme } from "@prisma/client";
+  export let readme: Readme;
+</script>
+
+<iframe
+  src={readme.url}
+  width="100%"
+  height="780"
+  scrolling="no"
+  frameborder="0"
+  allow="clipboard-write; autoplay; fullscreen"
+  class="publuuflip"
+  title="Readme of the month"
+></iframe>

src/lib/server/loadHomeData.ts

@@ -129,6 +129,8 @@ export const loadHomeData = async ({
     })
     .then((res) => res !== null);
 
+  const readmePromise = prisma.readme.findFirst();
+
   const [
     news,
     events,
@@ -137,6 +139,7 @@ export const loadHomeData = async ({
     cafeOpen,
     commitData,
     hasActiveMandate,
+    readme,
   ] = await Promise.allSettled([
     newsPromise,
     eventsPromise,
@@ -145,6 +148,7 @@ export const loadHomeData = async ({
     cafeOpenPromise,
     commitPromise,
     hasActiveMandatePromise,
+    readmePromise,
   ]);
   if (news.status === "rejected") {
     throw error(500, "Failed to fetch news");
@@ -167,6 +171,9 @@ export const loadHomeData = async ({
   if (hasActiveMandate.status === "rejected") {
     throw error(500, "Failed to fetch mandate data");
   }
+  if (readme.status === "rejected") {
+    throw error(500, "Failed to fetch readme");
+  }
 
   return {
     files: { next: nextBoardMeetingFiles, last: lastBoardMeetingFiles },
@@ -180,5 +187,6 @@ export const loadHomeData = async ({
     commitCount: commitData.value.commitCount,
     latestCommit: commitData.value.latestCommit,
     hasActiveMandate: hasActiveMandate.value,
+    readme: readme.value,
   };
 };

src/routes/(app)/home/+page.svelte

@@ -12,6 +12,7 @@
   import { getFullName } from "$lib/utils/client/member";
   import SetPageTitle from "$lib/components/nav/SetPageTitle.svelte";
   import * as m from "$paraglide/messages";
+  import Readme from "$lib/components/home/Readme.svelte";
   export let data: PageData;
 </script>
 
@@ -64,4 +65,10 @@
   <section class="md:col-span-3 xl:col-span-3">
     <Documents files={data.files} />
   </section>
+
+  <section class="md:col-span-3 xl:col-span-6">
+    {#if data.readme}
+      <Readme readme={data.readme} />
+    {/if}
+  </section>
 </div>

src/routes/(app)/readme/[year]/[number]/+page.server.ts

@@ -0,0 +1,17 @@
+import type { PageServerLoad } from "./$types";
+import { error } from "@sveltejs/kit";
+
+export const load: PageServerLoad = async ({ locals, params }) => {
+  const prisma = locals.prisma;
+  const { year, number } = params;
+  const readme = await prisma.readme.findFirst({
+    where: {
+      year: parseInt(year),
+      number: parseInt(number),
+    },
+  });
+  if (!readme) {
+    error(404, "README not found");
+  }
+  return { readme };
+};

src/routes/(app)/readme/[year]/[number]/+page.svelte

@@ -0,0 +1,7 @@
+<script lang="ts">
+  import type { PageData } from "./$types";
+  import Readme from "$lib/components/home/Readme.svelte";
+  export let data: PageData;
+</script>
+
+<Readme readme={data.readme} />