Migrate to react router 7, typescript, and misc. refactoring

.gitignore

@@ -1,5 +1,11 @@
+.env
+!.env.example
 .cache
+.DS_Store
+.react-router
 build
 node_modules
 git-feed.json
 latest-release.json
+*.tsbuildinfo
+.tool-versions

README.md

@@ -8,16 +8,16 @@ This website hosts the documentation for the [reoserv][reoserv] project
 Before you can run this project, you need to have the following installed on
 your machine:
 
-- [Node.js][node] v20+ (for local development with the Remix web framework)
-- [Bun][bun] v1.0.36+ (a modern package manager & script runner for Node.js
+- [Node.js][node] v22+ (for local development with the Remix web framework)
+- [Bun][bun] v1.1.36+ (a modern package manager & script runner for Node.js
   projects)
 
 Verify that both are setup on your system and meet our version requirements by
 running:
 
 ```sh
-bun --version    # eg: 1.0.36
-node --version   # eg: v20.4.0
+bun --version    # eg: 1.1.36
+node --version   # eg: v22.10.0
 ```
 
 ## Installation
@@ -47,6 +47,24 @@ To build the project, run:
 bun run build
 ```
 
+## Deployment
+
+Deploy the output of `bun run build`
+
+```
+├── package.json
+├── bun.lockb
+├── build/
+│   ├── client/    # Static assets
+│   └── server/    # Server-side code
+```
+
+Serve in production with:
+
+```
+bun run start
+```
+
 ## Linting / Formatting
 
 To format, lint and apply fixes at the same time, use:
@@ -61,6 +79,10 @@ To format markdown files (docs, news), use:
 bun run lint:docs
 ```
 
+---
+
+Built with ❤️ using React Router.
+
 [reoserv]: https://github.com/sorokya/reoserv
 [sorokya]: https://github.com/sorokya
 [node]: https://nodejs.org/

app/.server/content.ts

@@ -0,0 +1,69 @@
+import fs from 'node:fs/promises';
+import { glob } from 'glob';
+import { parseMarkdown } from './utils/parse-markdown';
+
+type Content = Awaited<ReturnType<typeof parseMarkdown>>;
+type ContentValue = { content: Content; mtimeMs: number };
+type ContentStore = Record<string, ContentValue>;
+
+// Simple in-memory store
+let contentStore: ContentStore | null = null;
+
+async function getFileContent(
+  filePath: string,
+  cached?: ContentValue,
+): Promise<ContentValue> {
+  const stats = await fs.stat(filePath);
+
+  if (cached && cached.mtimeMs === stats.mtimeMs) {
+    return cached;
+  }
+
+  const content = await parseMarkdown(filePath);
+  return { content, mtimeMs: stats.mtimeMs };
+}
+
+async function loadAllContent(): Promise<ContentStore> {
+  const files = await glob('content/**/*.md');
+
+  const contents = await Promise.all(
+    files.map(async (filePath) => {
+      const key = filePath.replace(/^content\//, '').replace(/\.md$/, '');
+
+      try {
+        const content = await getFileContent(filePath, contentStore?.[key]);
+        return [key, content] as const;
+      } catch (error) {
+        console.error(`Failed to load content for ${key}:`, error);
+        return undefined;
+      }
+    }),
+  );
+
+  return Object.fromEntries(contents.filter(Boolean));
+}
+
+async function getStore(): Promise<ContentStore> {
+  if (process.env.NODE_ENV === 'development' || !contentStore) {
+    contentStore = await loadAllContent();
+  }
+  return contentStore;
+}
+
+async function getContentByType(
+  type: string,
+): Promise<Record<string, Content>> {
+  const store = await getStore();
+  return Object.fromEntries(
+    Object.entries(store)
+      .filter(([key]) => key.startsWith(`${type}/`))
+      .map(([key, data]) => [key, data.content]),
+  );
+}
+
+async function getContentByKey(key: string): Promise<Content | undefined> {
+  const store = await getStore();
+  return store[key]?.content;
+}
+
+export { getContentByKey, getContentByType };

app/.server/get-docs-page.ts

@@ -0,0 +1,7 @@
+import { getContentByKey } from './content';
+
+async function getDocsPage(slug: string) {
+  return await getContentByKey(`docs/${slug}`);
+}
+
+export { getDocsPage };

app/.server/get-git-feed.ts

@@ -0,0 +1,69 @@
+import fs from 'node:fs';
+import { z } from 'zod';
+
+const GithubCommitsAPISchema = z.array(
+  z.object({
+    sha: z.string().min(1),
+    html_url: z.string().url().min(1),
+    commit: z.object({
+      message: z.string().min(1),
+      committer: z.object({
+        date: z.string().datetime().min(1),
+      }),
+    }),
+  }),
+);
+
+const StoredCommitsSchema = z.array(
+  z.object({
+    id: z.string().min(1),
+    link: z.string().url().min(1),
+    content: z.string().min(1),
+    timestamp: z.string().datetime().min(1),
+  }),
+);
+
+const GITHUB_URL =
+  'https://api.github.com/repos/sorokya/reoserv/commits?sha=master&per_page=20';
+const DATA_FILE_PATH = 'git-feed.json';
+const MAX_FILE_AGE = 5 * 60 * 1000; // 5 minutes in milliseconds
+
+async function getGitFeed() {
+  // Check file age or existence
+  const fileStats =
+    fs.existsSync(DATA_FILE_PATH) && fs.statSync(DATA_FILE_PATH);
+  const fileAge = fileStats
+    ? Date.now() - fileStats.mtime.getTime()
+    : Number.POSITIVE_INFINITY;
+
+  if (!fileStats || fileAge > MAX_FILE_AGE) {
+    const commits = await fetchGitFeed();
+    const json = JSON.stringify(commits);
+    fs.writeFileSync(DATA_FILE_PATH, json);
+    return commits;
+  }
+
+  const fileContents = fs.readFileSync(DATA_FILE_PATH, { encoding: 'utf8' });
+  const json = JSON.parse(fileContents);
+  const commits = StoredCommitsSchema.parse(json);
+  return commits;
+}
+
+async function fetchGitFeed() {
+  const response = await fetch(GITHUB_URL);
+
+  if (!response.ok) {
+    throw new Error('Failed to fetch commits from github');
+  }
+
+  const commits = GithubCommitsAPISchema.parse(await response.json());
+
+  return commits.map((commit) => ({
+    id: commit.sha,
+    link: commit.html_url,
+    content: commit.commit.message.split(/\r?\n/)[0],
+    timestamp: new Date(commit.commit.committer.date).toISOString(),
+  }));
+}
+
+export { getGitFeed };

app/.server/get-latest-release.ts

@@ -0,0 +1,58 @@
+import fs from 'node:fs';
+import { z } from 'zod';
+
+const GithubReleaseAPISchema = z.object({
+  name: z.string().min(1),
+  published_at: z.string().datetime().min(1),
+  html_url: z.string().url().min(1),
+});
+
+const LatestReleaseSchema = z.object({
+  name: z.string().min(1),
+  timestamp: z.string().datetime(),
+  link: z.string().url().min(1),
+});
+
+const GITHUB_URL =
+  'https://api.github.com/repos/sorokya/reoserv/releases/latest';
+const DATA_FILE_PATH = 'latest-release.json';
+const MAX_FILE_AGE = 5 * 60 * 1000; // 5 minutes in milliseconds
+
+async function getLatestRelease() {
+  // Check file age or existence
+  const fileStats =
+    fs.existsSync(DATA_FILE_PATH) && fs.statSync(DATA_FILE_PATH);
+  const fileAge = fileStats
+    ? Date.now() - fileStats.mtime.getTime()
+    : Number.POSITIVE_INFINITY;
+
+  if (!fileStats || fileAge > MAX_FILE_AGE) {
+    const latestRelease = await fetchLatestRelease();
+    const json = JSON.stringify(latestRelease);
+    fs.writeFileSync(DATA_FILE_PATH, json);
+    return latestRelease;
+  }
+
+  const fileContents = fs.readFileSync(DATA_FILE_PATH, { encoding: 'utf8' });
+  const json = JSON.parse(fileContents);
+  const latestRelease = LatestReleaseSchema.parse(json);
+  return latestRelease;
+}
+
+async function fetchLatestRelease() {
+  const response = await fetch(GITHUB_URL);
+
+  if (!response.ok) {
+    throw new Error('Failed to fetch the latest release from github');
+  }
+
+  const release = GithubReleaseAPISchema.parse(await response.json());
+
+  return {
+    name: release.name,
+    timestamp: new Date(release.published_at).toISOString(),
+    link: release.html_url,
+  };
+}
+
+export { getLatestRelease };