# 本地node静态服务

**Repository Path**: superleven/local-node-static-service

## Basic Information

- **Project Name**: 本地node静态服务
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-18
- **Last Updated**: 2026-04-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Local Node Static Service

一个基于 Node.js 的本地静态文件服务工具，用于快速启动本地服务器以提供静态资源访问服务。

## 项目简介

在开发前端应用时，直接打开 HTML 文件（使用 `file://` 协议）可能会遇到一些问题，例如：
- AJAX 请求受到同源策略限制
- ES6 模块无法正常加载
- 其他与协议相关的限制

此项目旨在解决这些问题，提供一个轻量级的本地 HTTP 服务器，可以方便地在本地预览和测试静态网站。

## 功能特点

- 快速启动本地 HTTP 服务器
- 自动打开默认浏览器
- 支持多种静态资源类型（HTML, CSS, JS, 图片等）
- 自动处理 MIME 类型
- 支持自定义端口（通过设置 PORT 环境变量）
- 提供构建脚本，可将项目打包到 dist 目录

## 目录结构

```
.
├── src/              # 静态资源目录
│   ├── index.html    # 主页
│   ├── css/          # CSS 文件目录
│   └── js/           # JavaScript 文件目录
├── main.js           # 服务器主文件
├── build.js          # 构建脚本
└── package.json      # 项目配置文件
```

## 使用场景

### 本地开发预览
在日常开发过程中，可以使用该工具快速预览静态页面效果，避免直接使用 `file://` 协议带来的各种问题。

### 生产环境部署前测试
在不方便交付源码的情况下，可以将打包后的文件放入 [src](./src) 文件夹下，这样既能避免交付源码，又能保证演示环境与开发环境的一致性。

### CI/CD 自动化部署
配合 Jenkins 等自动化部署工具，可以将构建好的静态资源放入 [src](./src) 目录，然后通过统一的命令启动服务，实现标准化部署流程。

## 安装与使用

### 前置要求

- Node.js (推荐 LTS 版本)

### 安装

克隆或下载本项目到本地：

```bash
git clone <项目地址>
cd local-node-static-service
```

### 启动本地服务器

```bash
npm run serve
```

执行该命令将会：
1. 在本地启动一个 HTTP 服务器，默认端口为 3000
2. 自动在默认浏览器中打开 `http://localhost:3000`
3. 提供 [src](./src) 目录下静态资源的访问

如果需要使用其他端口，可以通过设置 PORT 环境变量来实现：

```bash
PORT=8080 npm run serve
```

### 构建项目

```bash
npm run build
```

执行该命令将会：
1. 删除现有的 [dist](./dist) 目录（如果存在）
2. 将 [src](./src) 目录中的所有文件复制到 [dist](./dist) 目录
3. 输出构建完成信息

构建后的文件位于 [dist](./dist) 目录中，可用于部署到生产环境。

## 配置说明

### 端口配置

默认情况下，服务器监听 3000 端口。可以通过设置环境变量 PORT 来修改：

- Windows (cmd): `set PORT=8080 && npm run serve`
- Windows (PowerShell): `$env:PORT=8080; npm run serve`
- macOS/Linux: `PORT=8080 npm run serve`

### 支持的 MIME 类型

服务器支持以下常见的 MIME 类型：
- .html: text/html
- .css: text/css
- .js: text/javascript
- .json: application/json
- .png: image/png
- .jpg/.jpeg: image/jpeg
- .gif: image/gif
- .ico: image/x-icon
- .svg: image/svg+xml
- .woff: font/woff
- .woff2: font/woff2
- .ttf: font/ttf

未在列表中的文件类型将使用 application/octet-stream 作为默认 MIME 类型。

## 注意事项

1. 此工具仅适用于本地开发和测试，不应用于生产环境
2. 服务器默认绑定到 localhost，不建议将其暴露到公网
3. 当前没有实现热重载功能，修改文件后需要手动刷新浏览器

## 许可证

ISC