https://github.com/jaywcjlove/sgo
A dev server for rapid prototyping. Setting a directory to a static server.It provides a 404 neat interface for listing the directory's contents and switching into sub folders.
https://github.com/jaywcjlove/sgo
javascript mock-server mocker-api nodejs proxy-server server server-go sgo ssr typescript
Last synced: 17 days ago
JSON representation
A dev server for rapid prototyping. Setting a directory to a static server.It provides a 404 neat interface for listing the directory's contents and switching into sub folders.
- Host: GitHub
- URL: https://github.com/jaywcjlove/sgo
- Owner: jaywcjlove
- License: mit
- Created: 2015-10-11T17:42:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-19T18:30:15.000Z (about 1 year ago)
- Last Synced: 2024-05-28T13:33:44.434Z (11 months ago)
- Topics: javascript, mock-server, mocker-api, nodejs, proxy-server, server, server-go, sgo, ssr, typescript
- Language: EJS
- Homepage: https://jaywcjlove.github.io/sgo
- Size: 1.13 MB
- Stars: 207
- Watchers: 18
- Forks: 42
- Open Issues: 6
-
Metadata Files:
- Readme: README-zh.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[English](README.md) • [sgo](https://github.com/jaywcjlove/sgo-rs) rust
用于快速原型设计的开发服务。它提供了一个简洁的界面，用于列出目录的内容并切换到子文件夹，以当前目录为根目录快速起一个静态服务。
此外，它在提供静态站点方面也很棒。 如果目录包含 `index.html` ，则serve将自动呈现它而不是提供目录内容，并将任何 `.html` 文件作为呈现页面而不是文件内容作为明文提供。
> 更名: `ssr` => `sgo`
> sgo: `Server Go` 的缩写
⚠️ `ssr` 已经捐赠给阿里某团队。
#### `特征`
🗂 提供目录中的脚本，样式，图像等静态内容。
🖥 将所有非文件请求（如`/`或`/ admin`）重新路由到单个文件。
♻️ 添加，删除或修改项目文件时重新加载浏览器。
📚 可读的 TypeScript 源代码，鼓励学习和贡献。
💥 删除冗余的 [proxy](https://github.com/jaywcjlove/mocker-api) 功能, 代理功能请使用 [mocker-api](https://github.com/jaywcjlove/mocker-api)。
⚛️ 支持预览 React/Vue/Angular 项目的静态页面。
### 快速开始
使用 `npm i sgo -D` 添加 `sgo` 作为 `dev` 依赖项或直接从终端运行：
```bash
npm install -g sgo # 全局安装 sgo
sgo # 创建一个服务
# 或者
npx sgo [--port] [--dir]
```
### 命令帮助
```bash
Usage: sgo [options]
Options:
--version Show version number [boolean]
--port, -p Set the port. [number] [default: 1987]
--reload-port Set the reload port. [number] [default: 19872]
--reload, -r browser from reloading when files change.
[boolean] [default: true]
--dir, -d Specified directory. [string] [default: ""]
--browser, -b Browser from opening when the server starts.
[boolean] [default: true]
--fallback The file served for all non-file requests.
[string] [default: ""]
--help Show help [boolean]
Examples:
$ sgo Start a dev server.
$ sgo --no-browser Prevents the browser from opening when the
server starts.
$ sgo --no-reload prevents the browser from reloading when
files change.
$ sgo --fallback dir/index.html The file served for all non-file requests..
$ sgo -p 2019 Designated port.
$ sgo -d node_modules/dir Specified directory "node_modules/dir".
Copyright 2019
```
在项目的 `package.json` 文件中使用 `npm` 脚本的示例：
```json
{
"scripts": {
"start": "npx sgo -p 2019"
}
}
```
### 在 Node.js 中使用
```js
const sgo = require('sgo');
// Create server
sgo.default({ port: 1987, dir: '' });
```
```js
import server from 'sgo';
// Create server
server({ port: 1987, dir: '' });
```
### License
MIT © [Kenny Wong](https://wangchujiang.com/)