mirror of
https://github.com/DorkSquadRR/DorkNet.git
synced 2026-10-26 07:28:45 -07:00
Add initial documentation and structure for DorkNet project
- Create README.md for project overview and setup instructions - Add admin-ui/README.md for admin UI details and development setup - Introduce client-mod/README.md explaining the MelonLoader mod functionality - Establish docker/README.md for Docker setup and configuration - Create docs/README.md to index project documentation - Implement advanced-setup.md for Docker stack configuration - Document architecture in architecture.md - Provide easy-setup.md for hosting instructions - Add FAQ.md for common questions and legal considerations - Create joining-a-server.md for player connection instructions - Establish troubleshooting.md for common issues and resolutions - Introduce easy-app/README.md for the unified desktop application - Add server/README.md for ASP.NET Core backend details - Document tools/README.md for CLI helper scripts
This commit is contained in:
@@ -0,0 +1,36 @@
|
||||
# admin-ui/
|
||||
|
||||
React + Vite + Tailwind SPA. Talks to `/api/admin/v1/*` on the server.
|
||||
|
||||
Embedded into:
|
||||
1. The standalone server's `wwwroot/admin/` (advanced mode), served at
|
||||
`https://admin.<your-domain>/`.
|
||||
2. The Easy desktop app via a Photino WebView (host mode admin tab).
|
||||
|
||||
## Dev
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run dev # http://localhost:5173, proxies /api → :5000
|
||||
```
|
||||
|
||||
Start the server first; Vite's proxy doesn't synthesize endpoints.
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
npm run build # dist/ — copied into server/wwwroot/admin by the
|
||||
# server's CI publish step, and into easy-app/Resources/
|
||||
# by tools/build-easy-app.ps1
|
||||
```
|
||||
|
||||
## Stack notes
|
||||
|
||||
- React 18 + Vite 5 + TypeScript
|
||||
- Tailwind 3 with a custom dark `ink/brand` palette in `tailwind.config.js`
|
||||
- React Router 6
|
||||
- No external component library; primitives in `src/components/`
|
||||
- No state library beyond per-page `useState` + `useApi`
|
||||
|
||||
See [docs/architecture.md](../docs/architecture.md) for how the SPA is
|
||||
delivered in both modes.
|
||||
Reference in New Issue
Block a user