Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lzwme/static-server
一个基于 nodejs 的简易静态服务器，方便随时开发调试使用。
https://github.com/lzwme/static-server
lzwme nodejs server
Last synced: about 1 month ago
JSON representation
一个基于 nodejs 的简易静态服务器，方便随时开发调试使用。
- Host: GitHub
- URL: https://github.com/lzwme/static-server
- Owner: lzwme
- License: mit
- Created: 2021-07-12T05:38:05.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-25T08:52:15.000Z (about 1 year ago)
- Last Synced: 2024-04-26T05:41:07.522Z (9 months ago)
- Topics: lzwme, nodejs, server
- Language: TypeScript
- Homepage:
- Size: 84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[][npm-url]
# @lzwme/sserver
[![NPM version][npm-badge]][npm-url]
[![node version][node-badge]][node-url]
[![npm download][download-badge]][download-url]
[![GitHub issues][issues-badge]][issues-url]
[![GitHub forks][forks-badge]][forks-url]
[![GitHub stars][stars-badge]][stars-url]
一个基于 Node.js 的简易静态服务器，用于辅助开发调试随启随用。
```bash
# 快速启动一个静态服务器
npx @lzwme/sserver -d ./dist
```
## 安装
```bash
# 全局安装
npm i -g @lzwme/sserver
ss -h
# 或者在项目中安装
npm i -D @lzwme/sserver
npm exec ss -- -h
# 或者直接使用 `npx`
npx @lzwme/sserver -h
```
## 使用
示例：
```bash
# 以当前目录下的 dist 作为静态根目录
ss -d ./dist
# 启用 https
ss --https
# 启用 https，指定域名(默认为 localhost)
ss -H --host local.lzw.me
# 启用 https，并保存默认生成的 ssl 证书
ss -H --ssl-cache ./cache
```
### 配置代理转发
支持通过配置文件 `ss.config.js` 指定代理转发等详细配置规则。
```bash
# 在当前目录初始化一个 ss.config.js 配置文件
ss init
```
配置文件内容示例：
```js
// ss.config.js
/** @type {import('@lzwme/sserver').SSConfig} */
module.exports = {
port: 8888,
https: false,
sslCache: '',
rootDir: '.',
// 代理转发配置
proxyConfig: [
// 内网代理企业微信机器人接口示例
{
api: '/proxy/cgi-bin/webhook/send',
config: {
target: 'https://qyapi.weixin.qq.com',
changeOrigin: true,
pathRewrite: {
'^/proxy/cgi-bin': '/cgi-bin',
},
},
},
],
}
```
## 开发
本地二次开发：
```bash
git clone https://github.com/lzwme/static-server.git
pnpm install
pnpm build
# dev
pnpm dev
# global link
npm link
```
或者 fork 本项目进行代码贡献。
**欢迎贡献想法与代码。**
## License
`@lzwme/sserver` is released under the MIT license.
该插件由[志文工作室](https://lzw.me)开发和维护。
[stars-badge]: https://img.shields.io/github/stars/lzwme/static-server.svg
[stars-url]: https://github.com/lzwme/static-server/stargazers
[forks-badge]: https://img.shields.io/github/forks/lzwme/static-server.svg
[forks-url]: https://github.com/lzwme/static-server/network
[issues-badge]: https://img.shields.io/github/issues/lzwme/static-server.svg
[issues-url]: https://github.com/lzwme/static-server/issues
[npm-badge]: https://img.shields.io/npm/v/@lzwme/sserver.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@lzwme/sserver
[node-badge]: https://img.shields.io/badge/node.js-%3E=_10.0.0-green.svg?style=flat-square
[node-url]: https://nodejs.org/download/
[download-badge]: https://img.shields.io/npm/dm/@lzwme/sserver.svg?style=flat-square
[download-url]: https://npmjs.org/package/@lzwme/sserver
[bundlephobia-url]: https://bundlephobia.com/result?p=@lzwme/sserver@latest
[bundlephobia-badge]: https://badgen.net/bundlephobia/minzip/@lzwme/sserver@latest