From 048a869c304624e3f61f03b306293b7b2126df27 Mon Sep 17 00:00:00 2001 From: Justin Bosker Date: Wed, 22 Jul 2026 00:48:58 +0200 Subject: [PATCH] docs: add initial README --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c8a7d42 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# Server Manager + +Dynamic Dedicated Server Management System. + +## Components + +* Manager +* Wrapper +* Shared +* Dashboard + +## Build + +Build all workspaces: + +```bash +npm run build --workspaces +``` + +## Development + +### Manager + +```bash +npm start --workspace manager +``` + +### Dashboard + +```bash +npm run dev --workspace dashboard +``` + +## Architecture + +### Manager + +Responsible for: + +* Server lifecycle management +* Dynamic scaling +* Wrapper communication +* Server registry + +### Wrapper + +Responsible for: + +* Process management +* Dedicated server control +* Server monitoring +* Status reporting + +### Shared + +Contains: + +* Common types +* Shared interfaces +* Communication contracts + +## Project Structure + +```text +server-manager/ +├── manager/ +├── wrapper/ +├── shared/ +└── dashboard/ +```