add swagger monitor (#2)

* add swagger-stats for monitor performance

* ignore volumes when perform lint

* fix name

* update README

.dockerignore

@@ -11,4 +11,4 @@ pnpm-lock.yaml
 eslint.config.mjs
 LICENSE
 volumes
-docker-compose,yaml
+docker-compose.yaml

README.md

@@ -1,9 +1,9 @@
 # VOYAGER
 This project is OpenAI-like API set for SkywardAI project.
 
-# BUILD & RUN
+## BUILD & RUN
 
-## Local Machine
+### Local Machine
 * This project developed on Node Version `v20.15.0`.  
 * Make sure you installed `Node.js`.  
 
@@ -19,4 +19,25 @@ npm install
 
 # RUN
 npm run
-```
+```
+
+### Container
+**Please make sure you have `docker` and `make` installed in your server** 
+```shell
+# to simply start with all needed containers started, please run
+make up
+# if you just want to build this project to docker container, please run
+make build
+# if you want to start only this project in docker, please run
+make start
+# PLEASE NOTE: make start will automatically run make build first
+```
+
+## Lint
+To start lint your code, simply run
+```shell
+npm run lint
+```
+
+## Monitor
+This project got monitor build with swagger-stats, when you got this project running, just go to `<Your Server>:<Your Port>/swagger-stats`

eslint.config.mjs

@@ -19,6 +19,7 @@ export default [
         } 
     },
     {
+        ignores: ["volumes/*"],
         rules: {
             'no-undef': 'off'
         }

index.js

@@ -5,11 +5,16 @@ import { configDotenv } from 'dotenv';
 
 import buildRoutes from './routes/index.js'
 
+import swStats from 'swagger-stats';
+
 configDotenv()
 
 const app = express();
 app.use(cors());
 app.use(bodyParser.json());
+app.use(swStats.getMiddleware({
+    name: "Voyager Swagger Monitor"
+}))
 
 buildRoutes(app);
 

package.json

@@ -21,6 +21,8 @@
     "dotenv": "^16.4.5",
     "eslint": "^9.8.0",
     "express": "^4.19.2",
-    "globals": "^15.8.0"
+    "globals": "^15.8.0",
+    "prom-client": "12",
+    "swagger-stats": "^0.99.7"
   }
 }