Initial MVP of Question Service

Author: sivayogasubramanian

questions/.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

questions/nodemon.json

@@ -0,0 +1,5 @@
+{
+  "watch": ["src"],
+  "ext": ".ts,.js",
+  "exec": "ts-node ./src/index.ts"
+}

questions/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "questions",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "dev": "nodemon"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "body-parser": "^1.20.2",
+    "compression": "^1.7.4",
+    "cors": "^2.8.5",
+    "express": "^4.18.2",
+    "mongoose": "^7.5.1"
+  },
+  "devDependencies": {
+    "@types/body-parser": "^1.19.2",
+    "@types/compression": "^1.7.3",
+    "@types/cors": "^2.8.14",
+    "@types/express": "^4.17.17",
+    "@types/mongoose": "^5.11.97",
+    "dotenv": "^16.3.1",
+    "nodemon": "^3.0.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2"
+  }
+}

questions/src/controllers/questions.ts

@@ -0,0 +1,93 @@
+import express from "express";
+import { QuestionDao } from "../models/questions";
+import { ApiResponse, EMPTY_OBJECT, StatusMessageType } from "../types";
+
+// GET /questions/:id
+export const getQuestion = async (
+  req: express.Request,
+  res: express.Response
+) => {
+  try {
+    const id = req.params.id;
+    if (!id) {
+      const response: ApiResponse = {
+        payload: EMPTY_OBJECT,
+        statusMessage: {
+          type: StatusMessageType.ERROR,
+          message: "No ID provided",
+        },
+      };
+
+      res.status(400).json(response);
+    }
+
+    const question = await QuestionDao.getQuestionById(id);
+    if (!question) {
+      const response: ApiResponse = {
+        payload: EMPTY_OBJECT,
+        statusMessage: {
+          type: StatusMessageType.ERROR,
+          message: "No question found",
+        },
+      };
+
+      res.status(404).json(response);
+    }
+
+    const response: ApiResponse = {
+      payload: question,
+      statusMessage: null,
+    };
+    res.status(200).json(response);
+  } catch (error) {
+    console.log(error);
+    const response: ApiResponse = {
+      payload: EMPTY_OBJECT,
+      statusMessage: {
+        type: StatusMessageType.ERROR,
+        message: "Something went wrong",
+      },
+    };
+
+    res.status(500).json(response);
+  }
+};
+
+// POST /questions
+export const createQuestion = async (
+  req: express.Request,
+  res: express.Response
+) => {
+  try {
+    const { title, description } = req.body;
+    if (!title || !description) {
+      const response: ApiResponse = {
+        payload: EMPTY_OBJECT,
+        statusMessage: {
+          type: StatusMessageType.ERROR,
+          message: "Title or description must provided",
+        },
+      };
+
+      res.status(400).json(response);
+    }
+
+    const question = await QuestionDao.createQuestion(title, description);
+    const response: ApiResponse = {
+      payload: question,
+      statusMessage: null,
+    };
+    res.status(201).json(response);
+  } catch (error) {
+    console.log(error);
+    const response: ApiResponse = {
+      payload: EMPTY_OBJECT,
+      statusMessage: {
+        type: StatusMessageType.ERROR,
+        message: "Something went wrong",
+      },
+    };
+
+    res.status(500).json(response);
+  }
+};

questions/src/index.ts

@@ -0,0 +1,31 @@
+import express from "express";
+import bodyParser from "body-parser";
+import compression from "compression";
+import cors, { CorsOptions } from "cors";
+import http from "http";
+import mongoose from "mongoose";
+import router from "./router";
+
+const MONGO_URL = "mongodb://localhost:27017/questions";
+
+mongoose.Promise = Promise;
+mongoose.connect(MONGO_URL);
+mongoose.connection.on("error", console.error);
+
+const corsOptions: CorsOptions = {
+  origin: "*",
+};
+
+const app = express();
+
+app.use(cors(corsOptions));
+app.use(compression());
+app.use(bodyParser.json());
+
+const server = http.createServer(app);
+
+server.listen(3000, () => {
+  console.log("Server is listening on port 3000");
+});
+
+app.use("/", router());

questions/src/models/questions.ts

@@ -0,0 +1,20 @@
+import mongoose from "mongoose";
+
+const QuestionSchema = new mongoose.Schema({
+  title: { type: String, required: true },
+  description: { type: String, required: true },
+});
+
+const QuestionModel = mongoose.model("Question", QuestionSchema);
+
+const getQuestionById = async (id: string) =>
+  QuestionModel.findById(id).then((question) => question?.toObject());
+const createQuestion = async (title: string, description: string) => {
+  const question = new QuestionModel({ title, description });
+  return question.save().then((question) => question.toObject());
+};
+
+export const QuestionDao = {
+  getQuestionById,
+  createQuestion,
+};

questions/src/router/index.ts

@@ -0,0 +1,9 @@
+import express from "express";
+import questions from "./questions";
+
+const router = express.Router();
+
+export default (): express.Router => {
+  questions(router);
+  return router;
+};

questions/src/router/questions.ts

@@ -0,0 +1,7 @@
+import { createQuestion, getQuestion } from "../controllers/questions";
+import express from "express";
+
+export default (router: express.Router) => {
+  router.get("/questions/:id", getQuestion);
+  router.post("/questions", createQuestion);
+};

questions/src/types/index.ts

@@ -0,0 +1,16 @@
+export const EMPTY_OBJECT = {};
+
+export enum StatusMessageType {
+  ERROR = "ERROR",
+  SUCCESS = "SUCCESS",
+}
+
+export interface StatusMessage {
+  type: StatusMessageType;
+  message: string;
+}
+
+export interface ApiResponse {
+  payload: Object;
+  statusMessage: StatusMessage | null;
+}

questions/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "node",
+    "baseUrl": "src",
+    "outDir": "dist",
+    "sourceMap": true,
+    "noImplicitAny": true
+  },
+  "include": ["src/**/*"]
+}