1- # 非常简单的个人导航网站
1+ # TinyNav · 非常简单的个人导航网站
22
3- 使用 [ 豆包] ( https://www.doubao.com/ ) 和 [ copilot] ( https://github.com/copilot ) 辅助开发。
3+ [ ![ GitHub Stars] ( https://img.shields.io/github/stars/hanxi/tiny-nav?style=flat-square )] ( https://github.com/hanxi/tiny-nav/stargazers )
4+ [ ![ Docker Pulls] ( https://img.shields.io/docker/pulls/hanxi/tiny-nav?style=flat-square )] ( https://hub.docker.com/r/hanxi/tiny-nav )
5+ [ ![ Docker Image Size] ( https://img.shields.io/docker/image-size/hanxi/tiny-nav?style=flat-square )] ( https://hub.docker.com/r/hanxi/tiny-nav )
46
5- - 体验地址: < https://nav.hanxi.cc/ >
6- - 不需要账号密码,请不要删东西。
7+ > ✨ 一款极简、自托管的个人导航网站,基于 Go + Vue 开发。
78
8- ## 使用 Docker 运行
9+ ** 在线体验地址** 👉 [ https://nav.hanxi.cc ] ( https://nav.hanxi.cc )
10+ 无需账号密码即可访问,请勿修改或删除公共数据 🙏
911
10- ### 用 Docker compose 启动
12+ ---
1113
12- 新建 ` docker-compose.yml ` 文件,内容如下:
14+ ## 🐳 使用 Docker 快速部署
1315
14- ``` yml
16+ ### 使用 Docker Compose
17+
18+ #### 国际镜像:
19+
20+ ``` yaml
1521services :
1622 tiny-nav :
1723 image : hanxi/tiny-nav
@@ -26,9 +32,9 @@ services:
2632 - /tiny-nav-data:/app/data
2733` ` `
2834
29- 国内镜像:
35+ #### 国内镜像:
3036
31- ` ` ` yml
37+ ` ` ` yaml
3238services :
3339 tiny-nav :
3440 image : docker.hanxi.cc/hanxi/tiny-nav
@@ -43,10 +49,16 @@ services:
4349 - /tiny-nav-data:/app/data
4450` ` `
4551
46- ### 用 Docker 启动
47-
4852启动命令:
4953
54+ ` ` ` bash
55+ docker compose up -d
56+ ```
57+
58+ ### 使用 Docker 运行
59+
60+ #### 国际镜像:
61+
5062``` bash
5163docker run -d \
5264 --name tiny-nav \
@@ -57,7 +69,7 @@ docker run -d \
5769 hanxi/tiny-nav
5870```
5971
60- 国内镜像启动 :
72+ ### 国内镜像 :
6173
6274``` bash
6375docker run -d \
@@ -69,53 +81,45 @@ docker run -d \
6981 docker.hanxi.cc/hanxi/tiny-nav
7082```
7183
72- ### 进入网站页面
73-
74- 使用浏览器访问 < http://ip:8080 > 即可, ip 改成你机器的ip。
75-
76- ## 下载运行
84+ 访问页面:打开浏览器访问 http://<你的IP>:8080
7785
78- 1 . 去 < https://github.com/hanxi/tiny-nav/releases > 下载对应平台的可执行文件
79- 2 . 以无用户密码的方式运行
86+ ## 🧩 本地运行(非 Docker)
8087
88+ 1 . 前往 Releases 页面 下载对应平台的可执行文件
89+ 2 . 无认证启动:
8190``` bash
8291./tiny-nav --port=58080 --no-auth
8392```
84-
85- 3 . 打开浏览器访问 < http://localhost:58080 > 即可。
86- 4 . 以有用户密码的方式运行
87-
93+ 3 . 有账号密码启动:
8894``` bash
8995./tiny-nav --port=58080 --user=admin --password=123456
90- ```
96+ ````
97+ 4. 访问地址:http://localhost:58080
9198
92- ## 编译运行
99+ # # 🔧 从源码编译
93100
94- ### 编译
95-
96- ```
101+ ` ` ` bash
97102sh build.sh
98103` ` `
99104
100- 这样会生成 ` tiny-nav ` 可执行文件。所有静态资源会被打包到 ` tiny-nav ` 可执行文件中。
101-
102- ### 启动
105+ 将生成 tiny-nav 可执行文件,所有前端资源已打包至其中。运行示例:
103106
104- ```
107+ ` ` ` bash
105108ENABLE_NO_AUTH=true LISTEN_PORT=58080 ./tiny-nav
106109` ` `
107110
108- 网页访问 < http://localhost:58080 > 即可。
111+ 访问:http://localhost:58080
112+
113+ # # 🧱 技术栈
109114
110- ## 技术栈
115+ - 后端:Golang
116+ - 前端:Vue 3
111117
112- - 后端 Golang
113- - 前端 Vue
118+ # # 📌 开发计划
114119
115- ## 未来开发计划
120+ - [ ] 支持只读模式:查看免登录,编辑需登录
121+ - [ ] 数据 MD5 对比,避免重复加载
122+ - [ ] 自动深色模式
123+ - [ ] 支持书签导入
124+ - [ ] 支持站内搜索
116125
117- - [ ] 查看模式:编辑需要账号密码,查看可以不用账号密码。
118- - [ ] 对比数据 md5 值,没变化则使用本地数据。
119- - [ ] 自动深色模式。
120- - [ ] 书签导入。
121- - [ ] 支持搜索。
0 commit comments