# 静态

**Repository Path**: sheto/static

## Basic Information

- **Project Name**: 静态
- **Description**: 一个简单易用的前端静态网页运行工具库
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-10
- **Last Updated**: 2025-09-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 静态服务, 网页预览

## README

# 静态服务器（0依赖）
以前自己开发静态时，浏览器打开html总会报错说找不到html中引用的文件，要么就是说不能允许访问。google后（百度搜索）需要通过服务器访问。但是每次要写很麻烦然后自己就慢慢搞了个这么个东西。

## 整体说明

- 文件类型参考的[mime](https://github.com/broofa/mime#readme)，但是进行了精简。
- 接口代理使用的[http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware#readme)，为了0依赖使用时需要自行下载。 

## 安装使用
### 本地安装
```bash
npm install @sheto/static -D
```

### 运行（采用所有默认配置）
```bash
npx static
```
### 可直接在对应目录运行
```bash
npx @sheto/static
```

## 参数配置

主打一个轻量好用，没那么多依赖或者弯弯绕绕。
支持4个参数配置，1个特殊配置。可单独配置，也可一起在命令行中配置。以下示例是默认的配置。

### 常规配置
```bash
npx static --host 127.0.0.1
npx static --port 80
npx static --dir ./
npx static --home index.html
```
- 默认运行目录是当前目录，也可以单独指定目录。
- 默认运行目录约定要有一个入口文件，名叫index.html，也可以更改为其他名称。

连起来就是默认访问127.0.0.1:80，默认返回./index.html

### 特殊配置

特殊配置就是静态文件中的接口访问，如果不设置就不会启用代理功能，转而去查找是否对应的文件，然后报错。
以下示例是默认的配置。--proxy支持4种配置方式
- 直接传需要代理目标地址127.0.0.1
- 传带协议的地址https://127.0.0.1
- 也可单独传需要代理的前缀/api
- 或者都一起传http://127.0.0.1/api

```bash
npx static --proxy http://127.0.0.1/api
```
连起来就是转发路径中包含/api的请求到http://127.0.0.1