Merge branch 'develop' into 2769_eliminate_ts_ignore_in_AdminGameSetu…

…p_Component
serge-web · Jul 9, 2024 · 5d2128c · 5d2128c
2 parents 8ac35f9 + 1551dbe
commit 5d2128c
Show file tree

Hide file tree

Showing 11 changed files with 1,113 additions and 24 deletions.
diff --git a/client/src/Components/Link.jsx b/client/src/Components/Link.jsx
@@ -1,5 +1,6 @@
 import { Component } from 'react'
 import { connect } from 'react-redux'
+import { REST_API_ROUTE, serverPath } from 'src/config'
 import { setCurrentViewFromURI } from '../ActionsAndReducers/setCurrentViewFromURI/setCurrentViewURI_ActionCreators'
 
 import 'src/themes/App.scss'
@@ -11,8 +12,11 @@ class Link extends Component {
 
     const aNewTab = e.metaKey || e.ctrlKey
     const anExternalLink = this.props.href.startsWith('http')
-
+  
     if (!aNewTab && !anExternalLink) {
+      if (this.props.href === REST_API_ROUTE) {
+        window.open(serverPath + REST_API_ROUTE)
+      }
       e.preventDefault()
       this.props.dispatch(setCurrentViewFromURI(this.props.href))
     }

diff --git a/client/src/Components/SidebarAdmin.jsx b/client/src/Components/SidebarAdmin.jsx
@@ -1,16 +1,19 @@
 import {
   ADMIN_ROUTE,
   MESSAGE_TEMPLATE_ROUTE,
-  WELCOME_SCREEN_EDIT_ROUTE
+  WELCOME_SCREEN_EDIT_ROUTE,
+  REST_API_ROUTE
 } from 'src/config'
 import Link from './Link'
 
 export default (props) => {
   const menus = {
     [ADMIN_ROUTE]: 'Games',
     [MESSAGE_TEMPLATE_ROUTE]: 'Message Templates',
-    [WELCOME_SCREEN_EDIT_ROUTE]: 'Welcome Screen'
+    [WELCOME_SCREEN_EDIT_ROUTE]: 'Welcome Screen',
+    [REST_API_ROUTE]: 'REST API' 
   }
+
   return (
     <div id='sidebar_admin'>
       {

diff --git a/client/src/api/wargames_api/index.ts b/client/src/api/wargames_api/index.ts
@@ -173,7 +173,7 @@ export const downloadAllWargames = (): void => {
   window.open(serverPath + 'downloadAll')
 }
 
-export const openFauxtonUI = ():void => {
+export const openFauxtonUI = (): void => {
   window.open(serverPath + 'db/_utils/')
 }
 

diff --git a/client/src/config/routes.ts b/client/src/config/routes.ts
@@ -7,6 +7,7 @@ export const CREATE_MESSAGE_ROUTE = '/create/message'
 export const EDIT_MESSAGE_ROUTE = '/edit/message'
 export const GAME_SETUP_ROUTE = '/serge/gameSetup'
 export const WELCOME_SCREEN_EDIT_ROUTE = '/serge/editWelcomeScreen'
+export const REST_API_ROUTE = 'api-docs/'
 export const EXPORT_ROUTE = '/serge/export'
 export const EXPORT_MESSAGES_SUBROUTE = '/messages'
 export const EXPORT_FORCES_SUBROUTE = '/foeces'

diff --git a/server/db/storybook b/server/db/storybook
diff --git a/server/db/wargame-lw7k3gk3.sqlite b/server/db/wargame-lw7k3gk3.sqlite
diff --git a/server/package.json b/server/package.json
@@ -21,6 +21,8 @@
     "pouchdb-replication": "^7.0.0",
     "socket.io": "^4.3.1",
     "sqlite3": "^5.1.6",
+    "swagger-jsdoc": "^6.2.8",
+    "swagger-ui-express": "^5.0.1",
     "uniqid": "^5.0.3"
   },
   "devDependencies": {
@@ -40,6 +42,7 @@
   "scripts": {
     "dev": "nodemon main.js",
     "start": "node main.js",
+    "serve-openapi": "node main.js --openapi",
     "lint": "eslint --fix **/*.js"
   }
 }