Concept

Key Concepts

Domain concepts and API design patterns


Overview

This page defines the core domain terms and API design patterns used throughout the Yanshan Meeting Big Data System. Understanding these concepts will help you navigate the system's architecture, use the API correctly, and deploy the application in meeting environments. Whether you are integrating with the API layer or setting up the portable package for a secretary, the definitions here are your authoritative reference.


Content

便携部署包 (Portable Package)

The 便携部署包 — also called the portable package or ZIP package — is a self-contained archive that bundles everything the system needs to run. You do not need to install Node.js, npm, pnpm, or any other software on the host computer before using it. Once you extract the ZIP, all required components are already in place. This design minimizes IT setup in meeting environments where rapid, low-friction deployment is essential.


书记员 (Secretary / Operator)

The 书记员 — the designated meeting secretary or operator — is the person who runs the system. The secretary's Windows 10 computer acts as the application host: it serves the web interface to both the local browser and other devices on the same network. All primary workflows begin and end at the secretary's machine.


启动系统.bat (Launch Script)

启动系统.bat is the Windows batch script included in the portable package that starts the application server. The secretary launches it with a double-click — no command-line knowledge is required. Internally, it invokes the bundled node.exe runtime to bring up the web application server. There is no separate start command or CLI tool; 启动系统.bat is the sole entry point for starting the system.


端口 3005 (Port 3005)

The application listens for browser connections on port 3005. This port number is fixed and pre-configured in the package — you do not need to change or specify it. You include it explicitly in every URL used to reach the system:

  • Local access: http://localhost:3005
  • LAN access: http://<secretary-computer-IP>:3005

All API requests from the web interface are also routed through this port via the API Layer.


局域网访问 (LAN Access)

局域网访问 — LAN access, network access, or remote access — refers to the ability of other computers on the same local area network to open the application in their own browsers. Because the web application server listens on all network interfaces at port 3005, any device that can reach the secretary's computer over the LAN can access the system by navigating to http://<secretary-computer-IP>:3005. No additional network configuration is required beyond basic LAN connectivity.


node.exe (Bundled Node.js Runtime)

node.exe is the JavaScript runtime engine bundled inside the portable package. It powers the web application server and the API Layer without requiring any separate installation. When 启动系统.bat runs, it uses this bundled node.exe directly. You never need to install, update, or manage Node.js on the secretary's computer — the bundled runtime is the only runtime the system uses.


API Design Patterns

The API Layer sits between the web interface rendered in the browser and the back-end business logic and data storage. It handles all data requests using standard HTTP semantics over port 3005. As a developer consuming this API, you interact with it via HTTP requests — the system is a web service, and all integration points are HTTP-based. Authentication details, endpoint paths, and request/response formats are documented in the API reference pages linked below.


Examples

Accessing the system locally after launching 启动系统.bat

After the secretary double-clicks 启动系统.bat, the web application server starts on port 3005. Open a browser on the same machine and navigate to:

http://localhost:3005

Expected result: The meeting big-data management interface loads in the browser.


Accessing the system from another device on the LAN

If the secretary's computer has the local IP address 192.168.1.42, any other device on the same network can reach the application at:

http://192.168.1.42:3005

Expected result: The same web interface loads on the remote device's browser, served by the web application server running on the secretary's machine.


Making an API request to the API Layer

All data operations go through the API Layer via HTTP. For example, a GET request to retrieve meeting data follows this general shape (replace the path with the specific endpoint from the API reference):

GET http://localhost:3005/api/<endpoint-path>
Accept: application/json

Expected result: The API Layer returns a JSON response containing the requested data. Exact endpoint paths, query parameters, and response schemas are detailed in the API reference.


Related concepts
  • API Reference — Detailed endpoint paths, request parameters, response schemas, and error codes for the API Layer.
  • Getting Started / Quickstart — Step-by-step instructions for the primary workflow: download → extract → launch → access locally → access over LAN.
  • LAN Network Setup — Guidance on finding the secretary's computer IP address and verifying LAN connectivity for 局域网访问.
  • Troubleshooting — Common issues with port 3005 availability, firewall rules affecting LAN access, and 启动系统.bat launch failures.