docs: restructure server and web documentation into ADR files and a

routing table
This commit is contained in:
2026-07-17 22:07:55 +08:00
parent f8494a44ca
commit 519aa35f1f
23 changed files with 710 additions and 654 deletions
+18 -38
View File
@@ -1,53 +1,33 @@
# MyGO
MyGO is a WebDisk (cloud drive) server, written in Go.
MyGO is a pre-alpha WebDisk server with a Go backend and a browser client.
**Current status**: pre-alpha — basic JWT authentication and file transfer flows
are available while their APIs and large-file behavior continue to evolve.
## Current Capabilities
---
- JWT access and refresh authentication
- Application passkeys
- File and directory management through `/api/v1`
- Local file storage with staged upload promotion
- Administrator user listing, lookup, and deletion
- React client with login, root file listing, upload, and download
## Roadmap
### v0
- [ ] CLI configuration management (`mygo config`)
- [x] User authentication (JWT)
- [x] Basic file upload / download / management (HTTP API)
- [ ] Admin endpoints
- [ ] WebDAV support
### Future
- [ ] Image server
- [ ] Pastebin & code snippet editing in sharing
- [ ] S3 storage backend
- [ ] Nextcloud-compatible API
---
APIs and large-file behavior continue to evolve.
## CLI
`mygo` is the backend entrypoint with these subcommands:
The repository currently provides one server command:
| Command | Description |
|---------|-------------|
| `mygo serve` | Start the backend server |
| `mygo config` | Manage instance configuration |
| `mygo status` | Show server status |
| `mygo serve` | Load configuration and start the HTTP server |
---
## Web Client
## Frontend
The browser client lives in `web/` and uses the same REST API as other clients. See [`web/README.md`](web/README.md) for development, testing, and browser-debugging instructions.
The frontend uses React + TypeScript and communicates with the backend via HTTP
API. Its first milestone supports login, a root file list, single-file upload,
and authenticated download. Frontend source is maintained in `web/`; see
[`web/README.md`](web/README.md) for development, testing, and browser-debugging
instructions.
## Documentation
---
## Development
See `docs/README.md` for the server and Web documentation index. See `AGENTS.md` for behavioral conventions.
- [Documentation index](docs/README.md)
- [Server roadmap](docs/server/roadmap.md)
- [Web roadmap](docs/web/roadmap.md)
- [Agent conventions](AGENTS.md)