aboutsummaryrefslogtreecommitdiffstats
path: root/docs/doc.md
blob: abe0d9cd430e381d10562ff614867e5a53e2e378 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
### API

The API provides both REST and Websocket endpoints. Each with their own purposes.


```postman

POST("user/login")
POST("user/register")

```
> The software provides other websocket enpoints that will deliver the live system resources when required.
> System software receives a UPDATE/POST request from the host device, which then gets "forwarded to the receiving user"

Structure

```bash
├── LICENSE
├── README.md
├── cmd
│   └── main.go
├── docs
│   └── doc.md
├── go.mod
├── go.sum
├── internal
│   ├── api
│   │   ├── data
│   │   │   ├── models
│   │   │   │   ├── cpu.go
│   │   │   │   ├── device.go
│   │   │   │   ├── disk.go
│   │   │   │   ├── ram.go
│   │   │   │   ├── token.go
│   │   │   │   └── user.go
│   │   │   ├── rest
│   │   │   │   ├── device_handler.go
│   │   │   │   ├── disk_handler.go
│   │   │   │   ├── ram_handler.go
│   │   │   │   └── user_handler.go
│   │   │   ├── services
│   │   │   │   ├── cpu_service.go
│   │   │   │   ├── ram_service.go
│   │   │   │   └── token_service.go
│   │   │   └── ws
│   │   │       ├── cpu_handler.go
│   │   │       └── ram_handler.go
│   │   └── routes
│   │       └── routes.go
│   ├── cache
│   │   └── redis.go
│   ├── config
│   │   └── config.go
│   ├── database
│   │   └── db.go
│   ├── migrations
│   │   ├── 20250503171210_session.go
│   │   ├── 20250624124146_user.go
│   │   ├── 20250625001518_device.go
│   │   ├── 20250625005811_cpu.go
│   │   ├── 20250625010423_ram.go
│   │   ├── 20250625010714_disk.go
│   │   └── 20250802215820_token.go
│   └── tests
│       └── user_test.go
├── key
└── pkg
    ├── scripts
    │   └── goose
    │       └── goose-synf
    └── utils
        └── logger
            └── logger.go

```