Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CareyWang/sub-web
https://github.com/CareyWang/sub-web
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/CareyWang/sub-web
- Owner: CareyWang
- License: mit
- Created: 2020-01-31T06:13:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-07T01:36:30.000Z (4 months ago)
- Last Synced: 2024-10-10T16:04:12.123Z (2 months ago)
- Language: Vue
- Homepage: https://sub-web.netlify.app/
- Size: 1.66 MB
- Stars: 5,070
- Watchers: 42
- Forks: 1,862
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - CareyWang/sub-web - (Vue)
README
# sub-web
基于 vue-cli 与 [tindy2013/subconverter](https://github.com/tindy2013/subconverter) 后端实现的配置自动生成。
## Table of Contents
- [ChangeLog](#ChangeLog)
- [Docker](#Docker)
- [Requirements](#Requirements)
- [Install](#install)
- [Usage](#usage)
- [Related](#Related)
- [Contributing](#contributing)
- [License](#license)
## ChangeLog
- 20200730
- 独立各类后端配置到 .env 文件中，现在修改后端只需要修改 .env 即可。
## Docker
```shell
docker run -d -p 58080:80 --restart always --name subweb careywong/subweb:latest
```
若需要对代码进行修改，你需要在本地构建镜像并运行。
注：每次修改代码，你都需要重新执行 docker build 来执行打包操作。
```shell
docker -v
Docker version 23.0.4, build f480fb1
docker build -t subweb-local:latest .
docker run -d -p 58080:80 --restart always --name subweb subweb-local:latest
```
## Requirements
你需要安装 [Node](https://nodejs.org/zh-cn/) 与 [Yarn](https://legacy.yarnpkg.com/en/docs/install) 来安装依赖与打包发布。你可以通过以下命令查看是否安装成功。
注：以下步骤为 Ubuntu 下相应命令，其他系统请自行修改。为了方便后来人解决问题，有问题请发 issue。
```shell
node -v
v16.20.0
yarn -v
1.22.19
```
## Install
```shell
yarn install
```
## Usage
```shell
yarn serve
```
浏览器访问
## Deploy
发布到线上环境，你需要安装依赖，执行以下打包命令，生成的 dist 目录即为发布目录。如需修改默认后端，请修改 src/views/Subconverter.vue 中 **defaultBackend** 配置项。
```shell
yarn build
```
你需要安装 nginx (或其他 web 服务器)并正确配置。以下为示例配置，你需要修改 example.com 为自己域名并配置正确的项目根路径（https 自行配置）。
```shell
server {
listen 80;
server_name example.com;
root /var/www/http/sub-web/dist;
index index.html index.htm;
error_page 404 /index.html;
gzip on; #开启gzip压缩
gzip_min_length 1k; #设置对数据启用压缩的最少字节数
gzip_buffers 4 16k;
gzip_http_version 1.0;
gzip_comp_level 6; #设置数据的压缩等级,等级为1-9，压缩比从小到大
gzip_types text/plain text/css text/javascript application/json application/javascript application/x-javascript application/xml; #设置需要压缩的数据格式
gzip_vary on;
location ~* \.(css|js|png|jpg|jpeg|gif|gz|svg|mp4|ogg|ogv|webm|htc|xml|woff)$ {
access_log off;
add_header Cache-Control "public,max-age=30*24*3600";
}
}
```
## Related
- [tindy2013/subconverter](https://github.com/tindy2013/subconverter)
- [CareyWang/MyUrls](https://github.com/CareyWang/MyUrls)
## Contributing
PRs accepted.
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
## License
MIT © 2020 CareyWang