Merge pull request 'docs: add initial README' (#1) from feature/change-readme into develop
Reviewed-on: #1
This commit was merged in pull request #1.
This commit is contained in:
@@ -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/
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user