Reroute doc and frontend endpoints using routers

Author: CodeCricut

server/src/index.js

@@ -3,20 +3,20 @@ import express from "express";
 import typesRouter from "./routers/types.js";
 import activitiesRouter from "./routers/activities.js";
 import docsRouter from "./routers/docs.js";
+import frontendRouter from "./routers/frontend.js";
+
 import cors from "cors";
-import path from "path";
 import mongoose from "mongoose";
 
 dotenv.config();
-const baseDirectory = path.resolve();
 
 try {
     await connectToDatabase();
     const port = getPort();
 
     const app = express();
     setupAppMiddleware(app);
-    setAppRoutes(app);
+    setupAppRoutes(app);
 
     app.listen(port, () =>
         console.log(`Listening on http://localhost:${port}`)
@@ -29,7 +29,6 @@ try {
 function setupAppMiddleware(app) {
     app.use(cors());
     app.use(express.json());
-    app.use(express.static(getClientBuildPath()));
     return app;
 }
 
@@ -40,15 +39,11 @@ async function connectToDatabase() {
     });
 }
 
-function setAppRoutes(app) {
+function setupAppRoutes(app) {
+    app.use("/", frontendRouter);
     app.use("/types", typesRouter);
     app.use("/activities", activitiesRouter);
     app.use("/docs", docsRouter);
-
-    // Setup React routing
-    app.get("/*", (req, res) => {
-        res.sendFile(path.join(getClientBuildPath(), "index.html"));
-    });
 }
 
 function getPort() {
@@ -61,16 +56,6 @@ function getPort() {
     return port;
 }
 
-function getClientBuildPath() {
-    const clientBuildPath = path.join(baseDirectory, "frontend/build");
-    if (!clientBuildPath) {
-        throw new Error(
-            `Could not resolve client build path.\tBase directory:${baseDirectory}`
-        );
-    }
-    return clientBuildPath;
-}
-
 function getMongoConnection() {
     const connection = process.env.MONGODB_URI;
     if (!connection) {

server/src/routers/docs.js

@@ -1,10 +1,45 @@
 import express from "express";
+import path from "path";
 import swaggerUi from "swagger-ui-express";
 import { swaggerSpec } from "../../swagger.config.js";
 
+const baseDirectory = path.resolve();
+
 const router = express.Router();
 
-router.use("/", swaggerUi.serve);
-router.get("/", swaggerUi.setup(swaggerSpec));
+router.use("/api", swaggerUi.serve);
+router.get("/api", swaggerUi.setup(swaggerSpec));
+
+// Server jsDocs website
+router.use("/server", express.static(getServerDocumentationPath()));
+router.get("/server", (req, res) => {
+    res.sendFile(path.join(getServerDocumentationPath(), "index.html"));
+});
+
+// Frontend jsDocs website
+router.use("/frontend", express.static(getFrontendDocumentationPath()));
+router.get("/frontend", (req, res) => {
+    res.sendFile(path.join(getFrontendDocumentationPath(), "index.html"));
+});
+
+function getServerDocumentationPath() {
+    const docPath = path.join(baseDirectory, "server/documentation/jsdocs");
+    if (!docPath) {
+        throw new Error(
+            `Could not resolve server documentation build path. Ensure that you run \"npm run generate-docs\" in the base directory.`
+        );
+    }
+    return docPath;
+}
+
+function getFrontendDocumentationPath() {
+    const docPath = path.join(baseDirectory, "frontend/documentation/jsdocs");
+    if (!docPath) {
+        throw new Error(
+            `Could not resolve server documentation build path. Ensure that you run \"npm run generate-docs\" in the base directory.`
+        );
+    }
+    return docPath;
+}
 
 export default router;

server/src/routers/frontend.js

@@ -0,0 +1,23 @@
+import express from "express";
+import path from "path";
+
+const baseDirectory = path.resolve();
+
+const router = express.Router();
+
+router.use("/", express.static(getClientBuildPath()));
+router.get("/", (req, res) => {
+    res.sendFile(path.join(getClientBuildPath(), "index.html"));
+});
+
+function getClientBuildPath() {
+    const clientBuildPath = path.join(baseDirectory, "frontend/build");
+    if (!clientBuildPath) {
+        throw new Error(
+            `Could not resolve client build path.\tBase directory:${baseDirectory}`
+        );
+    }
+    return clientBuildPath;
+}
+
+export default router;