Tutorial

Getting Started

Making your first API request


Overview

This page walks you through downloading, launching, and making your first HTTP request to the Yanshan Meeting Big Data System API. Because the package is fully self-contained — bundling node.exe and the application server inside a single ZIP — you can have a working API endpoint responding in minutes without installing any additional software. By the end of this tutorial you will be able to reach the web interface locally and confirm that the API layer is serving data correctly from a browser or HTTP client.


Prerequisites

Before you begin, make sure you have the following:

  • Windows 10 — the portable package is built and tested for Windows 10 only.
  • A modern web browser — used to verify the interface and make initial API requests (Chrome, Edge, and Firefox are all suitable).
  • An HTTP client (optional) — tools such as curl, PowerShell's Invoke-RestMethod, or any REST client let you inspect raw API responses. Node.js is not required on your machine; a bundled runtime is included in the package.

Quick start
  1. Download yanshan-meeting-bigdata-win10-portable-v5.zip from the Releases section of this repository.
  2. Extract the ZIP to a local folder, for example D:\盐山会议大数据系统.
  3. Double-click 启动系统.bat inside that folder to start the server.
  4. Open your browser and navigate to http://localhost:3005 to confirm the application is running.
  5. Send your first API request (see the Examples section below) to verify the API layer is responding.

Steps

Step 1 — Download the portable package

Go to the Releases page of this repository and download:

yanshan-meeting-bigdata-win10-portable-v5.zip

This is the only file you need. It contains the bundled node.exe runtime, the application server, and all dependencies.


Step 2 — Extract the archive

Right-click the ZIP file and choose Extract All…, then choose a destination path with no spaces and no special characters, for example:

D:\盐山会议大数据系统

After extraction you should see 启动系统.bat and a set of supporting folders at the root of that directory. If 启动系统.bat is missing, the archive may be incomplete — re-download it.


Step 3 — Launch the server

Double-click 启动系统.bat. A console window will open and the bundled node.exe will start the web application server. You do not need to open a terminal manually or type any commands.

Success looks like: the console window stays open and shows output indicating the server is listening. Do not close this window while you are using the system.


Step 4 — Verify local access

Open your browser and go to:

http://localhost:3005

Success looks like: the meeting management interface loads in the browser. If you see a connection error instead, return to Step 3 and confirm 启动系统.bat is still running.


Step 5 — Verify LAN access (optional)

If other devices on the same local network need to reach the API, find the IP address of the secretary's computer (run ipconfig in a Command Prompt and look for the IPv4 address). On any other device connected to the same network, open a browser and navigate to:

http://<secretary-computer-IP>:3005

Replace <secretary-computer-IP> with the actual IP address, for example http://192.168.1.42:3005.

Success looks like: the same interface loads on the remote device, confirming the API layer is reachable over the LAN.


Examples

Example 1 — Confirm the server is reachable with curl

From a terminal on the same machine (or any machine on the LAN), send a basic GET request to the root of the application:

curl http://localhost:3005

Expected output: an HTML document representing the meeting management interface. A 200 OK status confirms the web application server and API layer are running correctly.


Example 2 — Confirm the server is reachable with PowerShell

If you prefer PowerShell, use Invoke-WebRequest:

Invoke-WebRequest -Uri http://localhost:3005

Expected output:

StatusCode        : 200
StatusDescription : OK
Content           : <!DOCTYPE html>...

A StatusCode of 200 confirms the API layer is accepting requests.


Example 3 — Access from another device on the LAN

From any browser on a device connected to the same local network, navigate to (substituting the real IP address of the secretary's computer):

http://192.168.1.42:3005

Expected result: the meeting management interface loads, confirming that LAN access is working and the API is serving remote clients.


Troubleshooting

Issue: Double-clicking 启动系统.bat opens and immediately closes a console window

  • Likely cause: The extraction path contains unsupported characters, or the archive was not fully extracted.
  • Fix: Re-extract the ZIP to a simple path such as D:\盐山会议大数据系统, ensure no files are missing, and try again.

Issue: Browser shows "This site can't be reached" at http://localhost:3005

  • Likely cause: The server is not running. Either 启动系统.bat was not launched, or the console window was closed.
  • Fix: Double-click 启动系统.bat again and keep the console window open. Then refresh the browser.

Issue: The console window is open but port 3005 does not respond

  • Likely cause: Another application on the machine is already using port 3005.
  • Fix: Identify the conflicting process by running netstat -ano | findstr :3005 in a Command Prompt, stop that process, then re-launch 启动系统.bat.

Issue: Other devices on the LAN cannot reach http://<secretary-computer-IP>:3005

  • Likely cause: The Windows Firewall is blocking inbound connections on port 3005.
  • Fix: Add an inbound rule in Windows Defender Firewall that allows TCP traffic on port 3005, or temporarily disable the firewall on the secretary's computer to test connectivity.

Issue: Windows SmartScreen or antivirus blocks 启动系统.bat

  • Likely cause: The batch file or node.exe is being flagged because it was downloaded from the internet.
  • Fix: Right-click 启动系统.bat, choose Properties, and click Unblock at the bottom of the dialog. Do the same for node.exe if prompted. Then try launching again.