Add default images

Author: vietanhdev

.gitignore

@@ -8,4 +8,5 @@ dnn_models/data_preparation/data/combined_data/
 frontend/node_modules
 frontend/.next
 frontend/out
+chessai/frontend-dist
 *.egg-info

README.md

@@ -8,6 +8,7 @@ ChessAI is a groundbreaking tool that brings together computer vision, chess alg
 
 ## 2. Environment setup
 
+- Requirements: Python 3.9, [Conda](https://docs.conda.io/en/latest/miniconda.html), Node.js 18+.
 - Clone this repository.
 
 ```bash
@@ -22,6 +23,15 @@ conda activate chessai
 pip install -e .
 ```
 
+- Install Node.js packages and build the frontend.
+
+```bash
+cd chessai/frontend
+npm install
+cd ..
+bash build_frontend.sh
+```
+
 ## 3. Build chess engine
 
 - This project uses [godogpaw](https://github.com/hmgle/godogpaw) as the chess engine.
@@ -38,7 +48,7 @@ go build
 ## 4. Usage
 
 ```bash
-ENGINE_PATH="data/engines/godogpaw-macos-arm" python -m chessai.app
+ENGINE_PATH="data/engines/godogpaw-macos-arm" python -m chessai.app --run_app
 ```
 
 Replace `ENGINE_PATH` with the path to the chess engine executable file.

chessai/app.py

@@ -42,7 +42,7 @@
 def run_window():
     from tkinter import Tk
     import webview
-    webview.create_window("chessai", 'http://127.0.0.1:5678', width=1200, height=800)
+    webview.create_window("ChessAI - Chinese Chess Analyzer", 'http://127.0.0.1:5678', width=1400, height=800)
     webview.start()
     os._exit(0)
 
@@ -139,7 +139,7 @@ def main():
 
     # Import these after setting data_root
     from chessai.routers import system_monitor, xiangqi
-    from chessai.utils import extract_frontend_dist, extract_apps
+    from chessai.utils import extract_frontend_dist
     from chessai.database import engine, Base
 
     logging.info("Extracting frontend distribution...")
@@ -149,9 +149,6 @@ def main():
     extract_frontend_dist(static_folder)
     print(static_folder)
 
-    logging.info("Extracting apps...")
-    apps_folder = os.path.abspath(os.path.join(global_data.data_root, "apps"))
-    extract_apps(apps_folder)
 
     logging.info("Creating database tables...")
     Base.metadata.create_all(bind=engine)

chessai/routers/xiangqi.py

@@ -4,50 +4,61 @@
 import cv2
 
 
+DEFAULT_VISUALIZATION_FRAME = cv2.imread(
+    "data/default_visualization_frame.jpeg"
+)
+
 router = APIRouter(
     prefix="/api/xiangqi",
     tags=["Run services"],
 )
 
+
 def encode_image(image):
     _, buffer = cv2.imencode(".jpg", image)
     return buffer.tobytes()
 
+
 @router.get("/original_frame", response_class=Response)
 async def original_frame():
     with globals.frame_lock:
+        frame = None
         if globals.original_frame is None:
-            return ""
+            frame = DEFAULT_VISUALIZATION_FRAME
         else:
-            encoded_frame = encode_image(globals.original_frame)
-            return Response(
-                content=encoded_frame,
-                media_type="image/jpg",
-            )
+            frame = globals.original_frame
+        encoded_frame = encode_image(frame)
+        return Response(
+            content=encoded_frame,
+            media_type="image/jpg",
+        )
 
 
 @router.get("/debug_frame", response_class=Response)
 async def debug_frame():
     with globals.frame_lock:
+        frame = None
         if globals.debug_frame is None:
-            return ""
+            frame = DEFAULT_VISUALIZATION_FRAME
         else:
-            encoded_frame = encode_image(globals.debug_frame)
-            return Response(
-                content=encoded_frame,
-                media_type="image/jpg",
-            )
+            frame = globals.debug_frame
+        encoded_frame = encode_image(frame)
+        return Response(
+            content=encoded_frame,
+            media_type="image/jpg",
+        )
 
 
 @router.get("/visualization_frame", response_class=Response)
 async def visualization_frame():
     with globals.frame_lock:
+        frame = None
         if globals.visualization_frame is None:
-            return ""
+            frame = DEFAULT_VISUALIZATION_FRAME
         else:
-            encoded_frame = encode_image(globals.visualization_frame)
-            return Response(
-                content=encoded_frame,
-                media_type="image/jpg",
-            )
-
+            frame = globals.visualization_frame
+        encoded_frame = encode_image(frame)
+        return Response(
+            content=encoded_frame,
+            media_type="image/jpg",
+        )

chessai/utils.py

@@ -6,10 +6,8 @@
 import platform
 import shutil
 import subprocess
-import tempfile
-
 import pkg_resources
-import requests
+
 
 def open_file(path):
     """
@@ -45,28 +43,6 @@ def extract_frontend_dist(static_folder):
         return
 
 
-def extract_apps(static_folder):
-    """
-    Extract folder apps from package chessai
-    and put it in the same static folder for serving
-    """
-    if os.path.exists(static_folder):
-        logging.info(f"Refreshing {static_folder}...")
-        shutil.rmtree(static_folder, ignore_errors=True)
-    apps_folder = pkg_resources.resource_filename("chessai", "apps")
-    if os.path.exists(apps_folder):
-        pathlib.Path(static_folder).parent.mkdir(parents=True, exist_ok=True)
-        shutil.copytree(apps_folder, static_folder)
-    if not os.path.exists(static_folder):
-        logging.warning("apps not found in package chessai")
-        pathlib.Path(static_folder).mkdir(parents=True, exist_ok=True)
-        with open(os.path.join(static_folder, "index.html"), "w") as f:
-            f.write(
-                "<b>apps</b> not found in package chessai. Please run: <code>bash build_apps.sh</code>"
-            )
-        return
-
-
 def draw_message_box(width, height, message):
     """Draws a message box with the given width, height and message"""
     message_frame = np.zeros((height, width, 3), dtype=np.uint8)

data/default_visualization_frame.jpeg

@@ -78,8 +78,6 @@ def get_long_description():
         "chessai": [
             "chessai/frontend-dist/**/*",
             "chessai/frontend-dist/*",
-            "chessai/apps/**/*",
-            "chessai/apps/*",
         ]
     },
     include_package_data=True,