Update Setup

.eslintrc.json

@@ -1,9 +1,7 @@
 {
   "extends": ["next/core-web-vitals", "prettier"],
   "plugins": ["prettier"],
-  "ignorePatterns": [
-    "**/dist/*.js"
-  ],
+  "ignorePatterns": ["**/dist/*.js"],
   "rules": {
     "prettier/prettier": "error"
   }

.github/workflows/nextjs-github-pages.yml

@@ -47,6 +47,8 @@ jobs:
           NEXT_JS_OUTPUT: 'export'
           NEXT_JS_BASE_PATH: '/${{ github.event.repository.name }}'
           NEXT_JS_IMAGES_UNOPTIMIZED: true
+      - name: Build Docs
+        run: npm run docs:ci --if-present
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:

.gitignore

@@ -45,3 +45,6 @@ next-env.d.ts
 
 # lint
 eslint_report.json
+
+# docs
+docs

README.md

@@ -12,16 +12,26 @@ SPDX-License-Identifier: MIT
 
 ## How To Use This Template
 
-The template repository contains a template TypeScript Project.
+The template repository contains a template for a Next.js project providing automated GitHub Actions and setups for code linting, testing & test coverage report, docker deployments, a docker compose setup, local packages for modular deployment, and documentation generation and deployment.
 
 Follow these steps to customize it to your needs:
 
-1. Rename the TypeScript project.
+1. Rename the NextJS project.
+2. Modify, add, or remove the local packages found at `/packages/*` to separate code out into smaller modules.
+3. Add additional dependencies and edit the project in `/app` and the local Node packages.
 
 ## Getting Started
 
 You can run the project using the following command. You will need to install Node.js and npm, e.g., using [homebrew (recommended for macOS)](https://formulae.brew.sh/formula/node) or the official [Node.js installer](https://nodejs.org/en/download).
 
+1. Install All Dependencies
+
+```bash
+npm install
+```
+
+1. Start the Next.js Application
+
 ```bash
 npm run dev
 ```

package.json

@@ -2,7 +2,7 @@
   "name": "typescripttemplate",
   "version": "0.1.0",
   "license": "MIT",
-  "description": "Stanford BDHG TypeScript Template",
+  "description": "Stanford Biodesign Digital Health TypeScript Template",
   "keywords": [
     "Stanford",
     "Biodesign"
@@ -21,7 +21,9 @@
     "lint:fix": "eslint . --fix & prettier --write .",
     "lint:ci": "eslint --output-file eslint_report.json --format json .",
     "pretest": "npm --prefix packages/example-package run build",
-    "test": "jest"
+    "test": "jest",
+    "docs": "typedoc",
+    "docs:ci": "typedoc --out ./out/docs --githubPages true"
   },
   "dependencies": {
     "@stanfordbdhg/example-package": "file:../packages/example-package",
@@ -48,6 +50,7 @@
     "postcss": "^8",
     "prettier": "^3",
     "ts-jest": "^29",
+    "typedoc": "^0.25",
     "typescript": "^5"
   }
 }

packages/example-package/tsconfig.json

@@ -8,7 +8,6 @@
   },
   "include": ["src"],
   "typedocOptions": {
-    "$schema": "https://typedoc.org/schema.json",
     "includeVersion": true,
     "entryPoints": ["src/index.ts"]
   }

tsconfig.json

@@ -24,5 +24,11 @@
     }
   },
   "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules"],
+  "typedocOptions": {
+    "entryPoints": ["packages/*"],
+    "name": "Stanford Biodesign Digital Health TypeScript Template",
+    "entryPointStrategy": "packages",
+    "includeVersion": false
+  }
 }