init

backend/.env.sample

@@ -0,0 +1,3 @@
+PORT=8888
+HOST=0.0.0.0
+MONGO_CONNECTION_STRING=mongodb://localhost:27017/myMernApp

backend/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "backend",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "vitest run --coverage",
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "dev": "concurrently \"tsc -w \" \"nodemon dist/index.js\""
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "fastify": "^4.26.2",
+    "mongoose": "^8.2.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.30",
+    "@vitest/coverage-v8": "^1.4.0",
+    "concurrently": "^8.2.2",
+    "dotenv": "^16.4.5",
+    "nodemon": "^3.1.0",
+    "typescript": "^5.4.3",
+    "vitest": "^1.4.0"
+  }
+}

backend/src/index.ts

@@ -0,0 +1,21 @@
+import * as dotenv from 'dotenv'
+import { AppConfig } from './types/config'
+import { serverOf, serverStart } from './server'
+
+dotenv.config()
+
+const server = serverOf()
+
+const appConfig: AppConfig = {
+  host: process.env.HOST || 'localhost',
+  port: process.env.PORT ? parseInt(process.env.PORT) : 3000,
+  mongoConnectionString: process.env.MONGO_CONNECTION_STRING || ''
+}
+
+serverStart(appConfig)(server)
+  .then(() => {
+    console.log(`Server listening on ${appConfig.host}:${appConfig.port}`)
+  })
+  .catch((err) => {
+    console.error(err)
+  })

backend/src/models/todo.ts

@@ -0,0 +1,30 @@
+import mongoose from 'mongoose'
+
+import { Todo } from '../types/todo'
+
+const todoSchema: mongoose.Schema = new mongoose.Schema(
+  {
+    name: {
+      type: String,
+      required: true
+    },
+    description: {
+      type: String,
+      default: ''
+    },
+    status: {
+      type: Boolean,
+      required: true
+    }
+  },
+  {
+    timestamps: true
+  }
+)
+
+todoSchema.set('toJSON', {
+  virtuals: true,
+  versionKey: false
+})
+
+export default mongoose.models.Todo || mongoose.model<Todo>('Todo', todoSchema)

backend/src/plugins/mongodb.ts

@@ -0,0 +1,3 @@
+import mongoose from 'mongoose'
+
+export const establishConnection = (connectionString: string) => mongoose.connect(connectionString)

backend/src/repo/todo.ts

@@ -0,0 +1,14 @@
+import { ModifyResult, UpdateQuery } from 'mongoose'
+
+import TodoModel from '../models/todo'
+import { Todo, TodoBody } from '../types/todo'
+
+export const findAllTodos: () => Promise<Array<Todo>> = () => TodoModel.find().exec()
+
+export const createTodo: (todoBody: TodoBody) => Promise<Todo> = (todoBody) => TodoModel.create(todoBody)
+
+export const updateTodoById: (id: string, update: UpdateQuery<TodoBody>) => Promise<Todo | null> = (id, update) =>
+  TodoModel.findByIdAndUpdate(id, update, { new: true })
+
+export const deleteTodoById: (id: string) => Promise<ModifyResult<Todo>> = (id) =>
+  TodoModel.findByIdAndDelete(id).exec()

backend/src/routes/todo.ts

@@ -0,0 +1,67 @@
+import { FastifyInstance, RouteShorthandOptions } from 'fastify'
+
+import { addTodo, deleteTodo, getTodos, updateTodoStatus } from '../services/todo'
+import { TodoBody } from '../types/todo'
+
+export const TodoRouter = (server: FastifyInstance, opts: RouteShorthandOptions, done: (error?: Error) => void) => {
+  interface IdParam {
+    id: string
+  }
+  interface StatusBody {
+    status: boolean
+  }
+
+  server.get('/v1/todos', async (request, reply) => {
+    try {
+      const todos = await getTodos()
+      return reply.status(200).send({ todos })
+    } catch (error) {
+      server.log.error(`GET /v1/todos Error: ${error}`)
+      return reply.status(500).send(`[Server Error]: ${error}`)
+    }
+  })
+
+  server.post<{ Body: TodoBody }>('/v1/todos', async (request, reply) => {
+    try {
+      const todoBody = request.body
+      const todo = await addTodo(todoBody)
+      return reply.status(201).send({ todo })
+    } catch (error) {
+      server.log.error(`POST /v1/todos Error: ${error}`)
+      return reply.status(500).send(`[Server Error]: ${error}`)
+    }
+  })
+
+  server.put<{ Params: IdParam; Body: StatusBody }>('/v1/todos/:id', opts, async (request, reply) => {
+    try {
+      const id = request.params.id
+      const status = request.body.status
+      const todo = await updateTodoStatus(id, status)
+      if (todo) {
+        return reply.status(200).send({ todo })
+      } else {
+        return reply.status(404).send({ msg: `Not Found Todo:${id}` })
+      }
+    } catch (error) {
+      server.log.error(`PUT /v1/todos/${request.params.id} Error: ${error}`)
+      return reply.status(500).send(`[Server Error]: ${error}`)
+    }
+  })
+
+  server.delete<{ Params: IdParam }>('/v1/todos/:id', opts, async (request, reply) => {
+    try {
+      const id = request.params.id
+      const todo = await deleteTodo(id)
+      if (todo) {
+        return reply.status(204).send()
+      } else {
+        return reply.status(404).send({ msg: `Not Found Todo:${id}` })
+      }
+    } catch (error) {
+      server.log.error(`DELETE /v1/todos/${request.params.id} Error: ${error}`)
+      return reply.status(500).send(`[Server Error]: ${error}`)
+    }
+  })
+
+  done()
+}

backend/src/server.ts

@@ -0,0 +1,27 @@
+import fastify, { FastifyInstance, FastifyListenOptions } from 'fastify'
+import { AppConfig } from './types/config'
+import { establishConnection } from './plugins/mongodb'
+import { TodoRouter } from './routes/todo'
+
+export const serverOf: () => FastifyInstance = () => {
+  const server = fastify()
+
+  server.get('/ping', async (request, reply) => {
+    return reply.status(200).send({ msg: 'pong!' })
+  })
+
+  server.register(TodoRouter, { prefix: '/api' })
+
+  return server
+}
+
+export const serverStart: (appConfig: AppConfig) => (server: FastifyInstance) => Promise<FastifyInstance> =
+  (appConfig) => async (server) => {
+    await establishConnection(appConfig.mongoConnectionString)
+    const listenOptions: FastifyListenOptions = {
+      port: appConfig.port,
+      host: appConfig.host
+    }
+    await server.listen(listenOptions)
+    return server
+  }

backend/src/services/todo.ts

@@ -0,0 +1,25 @@
+import { ModifyResult } from 'mongoose'
+
+import * as repo from '../repo/todo'
+import { Todo, TodoBody } from '../types/todo'
+
+export const getTodos: () => Promise<Array<Todo>> = async () => {
+  const todos = await repo.findAllTodos()
+  return todos
+}
+
+export const addTodo: (todoBody: TodoBody) => Promise<Todo> = async (todoBody) => {
+  const newTodo = await repo.createTodo({
+    ...todoBody
+  })
+  return newTodo
+}
+
+export const updateTodoStatus: (id: string, newStatus: boolean) => Promise<Todo | null> = async (id, newStatus) => {
+  const todo = await repo.updateTodoById(id, { status: newStatus })
+  return todo
+}
+export const deleteTodo: (id: string) => Promise<ModifyResult<Todo>> = async (id) => {
+  const result = await repo.deleteTodoById(id)
+  return result
+}

backend/src/types/config.ts

@@ -0,0 +1,5 @@
+export type AppConfig = {
+  port: number
+  host: string
+  mongoConnectionString: string
+}

backend/src/types/todo.ts

@@ -0,0 +1,8 @@
+export type Todo = {
+  id: string
+  name: string
+  description: string
+  status: boolean
+}
+
+export type TodoBody = Omit<Todo, 'id'>

backend/test/server.test.ts

@@ -0,0 +1,17 @@
+import { describe, expect, test } from 'vitest'
+import { serverOf } from '../src/server'
+
+describe('Server Testing', () => {
+  const server = serverOf()
+
+  test('When send a GET request to /ping, it should return status code 200', async () => {
+    // act: send a GET request to /ping
+    const response = await server.inject({
+      method: 'GET',
+      url: '/ping'
+    })
+
+    // assert: response should be status code 200
+    expect(response.statusCode).toBe(200)
+  })
+})

backend/test/todo.spec.ts

@@ -0,0 +1,26 @@
+import { afterAll, afterEach, beforeAll, describe, expect, test, vi } from 'vitest'
+import { serverOf } from '../src/server'
+import * as TodoRepo from '../src/repo/todo'
+
+describe('Todo API Testing', () => {
+  const server = serverOf()
+
+  afterEach(() => {
+    vi.resetAllMocks()
+  })
+
+  test('Given an empty array return from repo function, When send a GET request to /api/v1/todos, Then it should response an empty array', async () => {
+    // assert: stub the repo function to return an empty array
+    vi.spyOn(TodoRepo, 'findAllTodos').mockImplementation(async () => [])
+
+    // act: send a GET request to /api/v1/todos
+    const response = await server.inject({
+      method: 'GET',
+      url: '/api/v1/todos'
+    })
+
+    // assert: response should be an empty array
+    const todos = JSON.parse(response.body)['todos']
+    expect(todos).toStrictEqual([])
+  })
+})

backend/tsconfig.json

@@ -0,0 +1,111 @@
+{
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "dist"],
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs" /* Specify what module code is generated. */,
+    "rootDir": "./src",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist" /* Specify an output folder for all emitted files. */,
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}

backend/vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    pool: 'forks'
+  }
+})