@seas-computing/nestjs-healthcheck 0.0.13-2 → 0.0.13

package/README.md

@@ -16,12 +16,25 @@ npm install @seas-computing/nestjs-healthcheck
 To add the nestjs healthcheck system, you should make the following changes in the consuming application's `AppModule` (or other root module):
 - be sure that the `ConfigModule` is at the top of the imports list
 - import and register the `HealthcheckModule` using `registerAsync`
-- import `TypeOrmModule` and `ValkeyModule`
+- import `TypeOrmModule` and `RedisModule`
 
 In the `ConfigService`, configuration values (i.e. `HealthcheckModuleOptions`) should be made available and passed as options to the `HealthcheckModule`.
 
-Example `app.module` from [oap-grad-database](https://github.huit.harvard.edu/SEAS/oap-grad-database/blob/develop/src/server/app.module.ts):
+Example `app.module` based on [oap-grad-database](https://github.huit.harvard.edu/SEAS/oap-grad-database/blob/develop/src/server/app.module.ts):
 ```ts
+import { MiddlewareConsumer, Module, NestModule, RequestMethod } from '@nestjs/common';
+import { LogMiddleware, LogModule } from '@seas-computing/nestjs-logging';
+import { TypeOrmModule, TypeOrmModuleOptions } from '@nestjs/typeorm';
+import { HarvardKeyModule } from '@seas-computing/nestjs-harvard-key';
+import { SessionModule, NestSessionOptions } from 'nestjs-session';
+import { RedisStore } from 'connect-redis';
+import { RedisModule, RedisModuleOptions } from '@nestjs-modules/ioredis';
+import { HealthcheckModule, HealthcheckModuleOptions } from '@seas-computing/nestjs-healthcheck';
+import Redis from 'iovalkey';
+import { ConfigModule } from './config/config.module';
+import { ConfigService } from './config/config.service';
+import { HealthCheckModule } from './healthCheck/healthCheck.module';
+
 @Module({
   imports: [
     ConfigModule,  // Ensure this is at the top
@@ -77,13 +90,6 @@ Example `app.module` from [oap-grad-database](https://github.huit.harvard.edu/SE
         },
       }),
     }),
-    AdvisorModule,
-    StudentModule,
-    StudentToAdvisorModule,
-    NoteModule,
-    ThesisModule,
-    DegreeProgramModule,
-    MilestonesModule,
     HealthcheckModule.registerAsync({ // Add HealthcheckModule
       imports: [ConfigModule],
       inject: [ConfigService],
@@ -149,7 +155,7 @@ public get healthcheckConfig(): HealthcheckModuleOptions {
       oidcCheckURL: this.oidcCheckURL,
       dbOptions: this.dbOptions,
       valkeyURL: this.valkeyURL,
-      version: this.buildVersion,
+      buildVersion: this.buildVersion,
       strategy: this.isProduction
         ? HEALTH_STRATEGY_NAME.HEALTHCHECK
         : HEALTH_STRATEGY_NAME.DEV,
@@ -159,7 +165,12 @@ public get healthcheckConfig(): HealthcheckModuleOptions {
 
 ## Sample Response
 
-You should receive a response that looks like this:
+After running
+```
+curl http://127.0.0.1:3001/[yourAppName]/health-check
+```
+
+from the cli, you should receive a response that looks like this:
 
 ```json
 {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seas-computing/nestjs-healthcheck",
-  "version": "0.0.13-2",
+  "version": "0.0.13",
   "description": "A standalone healthcheck module for NestJS apps",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",