Update README.md

Author: WarningImHack3r

README.md

@@ -13,7 +13,7 @@ Made with SvelteKit, TailwindCSS & shadcn-svelte.
 - RSS feeds for all packages
 - Dynamically computed badges to indicate whether a package is the Latest, a Major version, a Prerelease, or a Maintenance version
 - Sidebar with the number of unseen releases for each package
-- ...and more!
+- ...and much more!
 
 ## How does it work?
 
@@ -27,6 +27,20 @@ wrapper around GitHub releases.
 
 For more info, visit the [v2 release post](https://svelte-changelog.dev/devlog/v2).
 
+### Run locally
+
+The main requirements to run Svelte Changelog are the `.env` entries, which you can find an example of inside the `.env.example`:
+
+- `GITHUB_TOKEN`: a [classic GitHub token](https://github.com/settings/tokens) with the `public_repo` scope (that's it), required for API requests.
+- `KV_REST_API_TOKEN` (optional): the token for the API of the KV service (Redis). You can leave it empty; an in-memory cache is used during development.
+- `KV_REST_API_URL` (optional): the URL for the API of the KV service (Redis). You can leave it empty; an in-memory cache is used during development.
+- `PUBLIC_POSTHOG_KEY` (optional): the token for the analytics service I use, [PostHog](https://posthog.com). You can leave it empty; analytics are disabled in dev environments.
+
+> [!NOTE]
+> If other environment variables happen to be required for linting or compilation purposes, simply add them with an empty value inside your `.env` file
+
+That's it: your GitHub token will do most of the job, and you can run the website like any regular SvelteKit app (`pnpm i` && `pnpm dev`).
+
 ## Missing a package?
 
 If you think I missed a package, you can either open an issue or directly contribute.

src/lib/server/github-cache.ts

@@ -1,5 +1,12 @@
 import { dev } from "$app/environment";
-import { GITHUB_TOKEN, KV_REST_API_TOKEN, KV_REST_API_URL } from "$env/static/private";
+import {
+	GH_APP_ID,
+	GH_APP_INSTALLATION_TOKEN,
+	GH_APP_PRIV_KEY_BASE64,
+	GITHUB_TOKEN,
+	KV_REST_API_TOKEN,
+	KV_REST_API_URL
+} from "$env/static/private";
 import type {
 	CommentAuthorAssociation,
 	Issue as GQLIssue,
@@ -8,7 +15,7 @@ import type {
 	ReferencedSubject
 } from "@octokit/graphql-schema";
 import { Redis } from "@upstash/redis";
-import { Octokit } from "octokit";
+import { App, Octokit } from "octokit";
 import semver from "semver";
 import parseChangelog from "$lib/changelog-parser";
 import type { Repository } from "$lib/repositories";
@@ -182,7 +189,7 @@ export class GitHubCache {
 	 * @param githubToken the GitHub token for uncached API requests
 	 * @constructor
 	 */
-	constructor(redisUrl: string, redisToken: string, githubToken: string) {
+	constructor(redisUrl: string, redisToken: string, octokit: Octokit) {
 		this.#cache = new CacheHandler(
 			new Redis({
 				url: redisUrl,
@@ -191,9 +198,7 @@ export class GitHubCache {
 			dev
 		);
 
-		this.#octokit = new Octokit({
-			auth: githubToken
-		});
+		this.#octokit = octokit;
 	}
 
 	/**
@@ -977,4 +982,15 @@ export class GitHubCache {
 	}
 }
 
-export const githubCache = new GitHubCache(KV_REST_API_URL, KV_REST_API_TOKEN, GITHUB_TOKEN);
+export const githubCache = new GitHubCache(
+	KV_REST_API_URL,
+	KV_REST_API_TOKEN,
+	GITHUB_TOKEN
+		? new Octokit({
+				auth: GITHUB_TOKEN
+			})
+		: await new App({
+				appId: GH_APP_ID,
+				privateKey: Buffer.from(GH_APP_PRIV_KEY_BASE64, "base64").toString("utf8")
+			}).getInstallationOctokit(+GH_APP_INSTALLATION_TOKEN)
+);