@l1nsn0w/dox 0.1.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -33
- package/dox.js +1547 -944
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,16 +1,23 @@
|
|
|
1
1
|
# dox
|
|
2
2
|
|
|
3
|
-
A
|
|
3
|
+
> A quiet home for the things you need to do.
|
|
4
4
|
|
|
5
|
-
A
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
A self-hosted todo app you live in from the terminal — TUI by default, CLI
|
|
6
|
+
for scripts. One Go binary, one SQLite file, optional multi-user via invite.
|
|
7
|
+
|
|
8
|
+
Self-hosted, so it's yours. On every device, so it's always there. Open to a
|
|
9
|
+
few, when you'd like the company. Small enough to forget you're running it.
|
|
8
10
|
|
|
9
11
|
|
|
10
12
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
13
|
+
## Features
|
|
14
|
+
|
|
15
|
+
- TUI by default, CLI for scripts — same server, no separate daemon
|
|
16
|
+
- Projects + Inbox, markdown descriptions, done/undone
|
|
17
|
+
- Search across todos and projects
|
|
18
|
+
- Multi-user — first to register owns the server, others join by invite link
|
|
19
|
+
- Activity feed — see who changed what, when
|
|
20
|
+
- One container, one SQLite file — back it up with `cp`
|
|
14
21
|
|
|
15
22
|
## Deploy
|
|
16
23
|
|
|
@@ -18,20 +25,15 @@ The server is one container. One command, one persistent volume:
|
|
|
18
25
|
|
|
19
26
|
```bash
|
|
20
27
|
docker run -d --name dox \
|
|
21
|
-
-p
|
|
28
|
+
-p 6278:6278 \
|
|
22
29
|
-v /opt/dox/data:/app/data \
|
|
23
30
|
sn0wl1n/dox:latest
|
|
24
31
|
```
|
|
25
32
|
|
|
26
|
-
Or with `compose.yml
|
|
33
|
+
Or with Docker Compose — see [`docker/docker-compose.yml`](./docker/docker-compose.yml):
|
|
27
34
|
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
dox:
|
|
31
|
-
image: sn0wl1n/dox:latest
|
|
32
|
-
ports: ["8080:8080"]
|
|
33
|
-
volumes: ["./data:/app/data"]
|
|
34
|
-
restart: unless-stopped
|
|
35
|
+
```bash
|
|
36
|
+
docker compose -f docker/docker-compose.yml up -d
|
|
35
37
|
```
|
|
36
38
|
|
|
37
39
|
## Use
|
|
@@ -46,28 +48,16 @@ dox
|
|
|
46
48
|
The TUI handles onboarding (register · login · accept invite) and everything
|
|
47
49
|
after.
|
|
48
50
|
|
|
49
|
-
##
|
|
50
|
-
|
|
51
|
-
- **Server** — Go · grpc-gateway · sqlc · goose · SQLite
|
|
52
|
-
- **Client** — TypeScript · Ink · Bun
|
|
53
|
-
- **Contract** — `proto/dox/v1/` (auth, user, project, invite, todo)
|
|
54
|
-
|
|
55
|
-
IDs are ULID, timestamps are `int64` unix milliseconds, and only two routes
|
|
56
|
-
are public: `/v1/auth/register` and `/v1/auth/redeem`. Everything else needs
|
|
57
|
-
a device bearer token.
|
|
58
|
-
|
|
59
|
-
## Develop
|
|
51
|
+
## Dev
|
|
60
52
|
|
|
61
53
|
```bash
|
|
62
54
|
just gen # proto → Go + TS, sqlc → Go DB bindings
|
|
63
55
|
just serve # run the server locally
|
|
64
|
-
just cli
|
|
65
|
-
just release v0.1.0 # tag + push → triggers Docker Hub release
|
|
56
|
+
just cli # run the CLI against the local server
|
|
66
57
|
```
|
|
67
58
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
## License
|
|
59
|
+
> **Heads up:** dox is in early, active development — things will move and
|
|
60
|
+
> occasionally break between versions. Issues and pull requests warmly
|
|
61
|
+
> welcome at [github.com/lin-snow/dox](https://github.com/lin-snow/dox).
|
|
72
62
|
|
|
73
63
|
[AGPL-3.0](LICENSE)
|