Merge pull request #26 from quirrel-dev/human-friendly-index

Add index page

api/src/scheduler/index.ts

@@ -18,6 +18,7 @@ import cors from "fastify-cors";
 import telemetry from "./telemetry";
 import sentryPlugin from "./sentry";
 import loggerPlugin from "./logger";
+import indexRoute from "./routes/index";
 import { StructuredLogger } from "../shared/structured-logger";
 import { Logger } from "../shared/logger";
 
@@ -94,6 +95,7 @@ export async function createServer({
     app.register(usageRoute, { prefix: "/usage" });
   }
 
+  app.register(indexRoute);
   app.register(health, { prefix: "/health" });
   app.register(queues, { prefix: "/queues" });
   app.register(activityPlugin, { prefix: "/activity" });

api/src/scheduler/routes/index.ts

@@ -0,0 +1,46 @@
+import { FastifyPluginCallback } from "fastify";
+
+const welcomePage = `
+<h1>
+Welcome to the Quirrel API!
+</h1>
+
+<p>
+As an end-user, you're most likely looking for something else:
+</p>
+
+<ul>
+  <li>
+    <a href="https://quirrel.dev">Landing Page</a>
+  </li>
+  <li>
+    <a href="https://docs.quirrel.dev">Documentation</a>
+  </li>
+  <li>
+    <a href="https://github.com/quirrel-dev">Github</a>
+  </li>
+</ul>
+
+<p>
+If you didn't get here by accident, but want to interface directly with the Quirrel API,
+take a look at the OpenAPI spec:
+</p>
+
+<ul>
+  <li>
+    <a href="/documentation">Swagger Docs</a>
+  </li>
+  <li>
+    <a href="/documentation/docs.html">ReDocs</a>
+  </li>
+</ul>
+`.trim();
+
+const index: FastifyPluginCallback = (fastify, opts, done) => {
+  fastify.get("/", (request, reply) => {
+    reply.status(200).header("Content-Type", "text/html").send(welcomePage);
+  });
+  done();
+};
+
+export default index;