onee-io / short-url

简单易用的短链接生成工具，完全开源、免费、无需登录，可私有化部署，链接永久有效！

Short URL

将长链接转为短链接的小工具，完全开源、免费、无需登录，可私有化部署，可配合免费的无服务器云平台使用，短链接可永久有效。

体验地址 👉 缩啦 —— 简单易用的短链接生成工具，链接永久有效！

服务托管在 fly.io 平台，此平台可通过 Docker 部署任意类型的应用，前三个应用免费，推荐使用。

效果演示

环境依赖

• NodeJS 16+
• Redis 5+

部署步骤

前置操作

1. 执行 npm install 安装依赖包；

2. 将 .env.example 文件重命名为 .env，并按你的 Redis 实际情况填写好配置信息，说明如下：

配置	默认值	说明
REDIS_HOST	127.0.0.1	Redis 服务 IP 地址，支持 IPv6
REDIS_PORT	6379	Redis 服务端口
REDIS_USERNAME		用户名，没有留空即可
REDIS_PASSWORD		密码，没有留空即可

方式一：前后端分离部署

1. 执行 npm run server 启动后端服务，占用端口 3001；

2. 执行 npm start 启动前端服务，占用端口 3000；

3. 访问 http://localhost:3000 即可使用；

方式二：通过 express 代理静态资源部署（推荐）

1. 执行 npm run build 将前端编译为静态文件（生成的 build 目录不要删除）；

2. 执行 npm run server 启动服务；

3. 访问 http://localhost:3001 即可使用；

方式三：通过 Docker 部署（推荐）

1. 执行 docker build -t short-url . 打包镜像；

2. 执行 docker run -d -p3001:3001 short-url 启动容器；

3. 访问 http://localhost:3001 即可使用；