Skip to content

Commit b2d33dc

Browse files
authored
Update README.md
1 parent 26e7e89 commit b2d33dc

File tree

1 file changed

+155
-4
lines changed

1 file changed

+155
-4
lines changed

README.md

Lines changed: 155 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1-
# TinyNav · 非常简单的个人导航网站
1+
# TinyNav · 非常简单的个人导航网站 / A Simple Personal Navigation Website
22

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)
3+
Language: [中文](#中文版本) | [English](#english-version)
4+
5+
---
6+
7+
## 中文版本
8+
9+
[![GitHub Stars](https://img.shields.io/github/stars/hanxi/tiny-nav?style=flat-square)](https://github.com/hanxi/tiny-nav/stargazers)
10+
[![Docker Pulls](https://img.shields.io/docker/pulls/hanxi/tiny-nav?style=flat-square)](https://hub.docker.com/r/hanxi/tiny-nav)
511
[![Docker Image Size](https://img.shields.io/docker/image-size/hanxi/tiny-nav?style=flat-square)](https://hub.docker.com/r/hanxi/tiny-nav)
612

713
> ✨ 一款极简、自托管的个人导航网站,基于 Go + Vue 开发。
@@ -110,7 +116,7 @@ docker run -d \
110116

111117
```bash
112118
./tiny-nav --port=58080 --user=admin --password=123456
113-
````
119+
```
114120

115121
4. 访问地址:<http://localhost:58080>
116122

@@ -140,3 +146,148 @@ ENABLE_NO_AUTH=true LISTEN_PORT=58080 ./tiny-nav
140146
- [ ] 自动深色模式
141147
- [ ] 支持书签导入
142148
- [ ] 支持站内搜索
149+
150+
---
151+
152+
## English Version
153+
154+
[![GitHub Stars](https://img.shields.io/github/stars/hanxi/tiny-nav?style=flat-square)](https://github.com/hanxi/tiny-nav/stargazers)
155+
[![Docker Pulls](https://img.shields.io/docker/pulls/hanxi/tiny-nav?style=flat-square)](https://hub.docker.com/r/hanxi/tiny-nav)
156+
[![Docker Image Size](https://img.shields.io/docker/image-size/hanxi/tiny-nav?style=flat-square)](https://hub.docker.com/r/hanxi/tiny-nav)
157+
158+
> ✨ A minimalist, self-hosted personal navigation website developed using Go and Vue.
159+
160+
**Online Demo** 👉 [https://nav.hanxi.cc](https://nav.hanxi.cc)
161+
162+
- Username: admin
163+
- Password: 123456
164+
165+
> [!IMPORTANT]
166+
> Please do not modify or delete data 🙏
167+
168+
---
169+
170+
## Features
171+
172+
- Drag-and-drop sorting
173+
- Night mode
174+
- Compatible with desktop and mobile
175+
- Retrieve website icons or customize SVG icons
176+
- No-account mode: edit without needing username and password
177+
- View-only mode without account: browse without username and password; editing requires login
178+
179+
## 🐳 Quick Deployment Using Docker
180+
181+
### Using Docker Compose
182+
183+
#### International Image
184+
185+
```yaml
186+
services:
187+
tiny-nav:
188+
image: hanxi/tiny-nav
189+
container_name: tiny-nav
190+
restart: unless-stopped
191+
ports:
192+
- 8080:58080
193+
environment:
194+
NAV_USERNAME: admin
195+
NAV_PASSWORD: 123456
196+
volumes:
197+
- /tiny-nav-data:/app/data
198+
```
199+
200+
#### Domestic Image
201+
202+
```yaml
203+
services:
204+
tiny-nav:
205+
image: docker.hanxi.cc/hanxi/tiny-nav
206+
container_name: tiny-nav
207+
restart: unless-stopped
208+
ports:
209+
- 8080:58080
210+
environment:
211+
NAV_USERNAME: admin
212+
NAV_PASSWORD: 123456
213+
volumes:
214+
- /tiny-nav-data:/app/data
215+
```
216+
217+
Start command:
218+
219+
```bash
220+
docker compose up -d
221+
```
222+
223+
### Running with Docker
224+
225+
#### International Image
226+
227+
```bash
228+
docker run -d \
229+
--name tiny-nav \
230+
-p 8080:58080 \
231+
-e NAV_USERNAME=admin \
232+
-e NAV_PASSWORD=123456 \
233+
-v /tiny-nav-data:/app/data \
234+
hanxi/tiny-nav
235+
```
236+
237+
#### Domestic Image
238+
239+
```bash
240+
docker run -d \
241+
--name tiny-nav \
242+
-p 8080:58080 \
243+
-e NAV_USERNAME=admin \
244+
-e NAV_PASSWORD=123456 \
245+
-v /tiny-nav-data:/app/data \
246+
docker.hanxi.cc/hanxi/tiny-nav
247+
```
248+
249+
Access the site by opening your browser and visiting http://<yourIP>:8080
250+
251+
## 🧩 Running Locally (Without Docker)
252+
253+
1. Visit the Releases page to download the executable for your platform.
254+
2. Start without authentication:
255+
256+
```bash
257+
./tiny-nav --port=58080 --no-auth
258+
```
259+
260+
3. Start with account authentication:
261+
262+
```bash
263+
./tiny-nav --port=58080 --user=admin --password=123456
264+
```
265+
266+
4. Access: <http://localhost:58080>
267+
268+
## 🔧 Compiling from Source
269+
270+
```bash
271+
sh build.sh
272+
```
273+
274+
This will generate the tiny-nav executable file, with all frontend resources bundled within. Example of running:
275+
276+
```bash
277+
ENABLE_NO_AUTH=true LISTEN_PORT=58080 ./tiny-nav
278+
```
279+
280+
Access: <http://localhost:58080>
281+
282+
## 🧱 Tech Stack
283+
284+
- Backend: Golang
285+
- Frontend: Vue 3
286+
287+
## 📌 Development Plan
288+
289+
- [x] Support read-only mode: view without login, edit requires login
290+
- [x] Pull data only on changes to avoid redundant loading
291+
- [ ] Automatic dark mode
292+
- [ ] Support bookmark import
293+
- [ ] Support in-site search

0 commit comments

Comments
 (0)