README
¶
Mechanus - Server
- Provides the files
- Login and users
Development
You can either use the vscode launch configuration launch server or run the following commands:
make start-server
Documentation
Data
The server uses SQLite for data and blob storage. because of the config it saves to server/.local/db.sqlite
Documentation
¶
Overview ¶
The main entry point of any mechanus program, setups config, logging and folders then goes to ./cmd
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package application orchestrates use cases.
|
Package application orchestrates use cases. |
|
Package cmd contains the Cobra CLI entrypoints.
|
Package cmd contains the Cobra CLI entrypoints. |
|
Package components acts as the dependency injection container (composition root).
|
Package components acts as the dependency injection container (composition root). |
|
Package engine contains the core business rules and entities of the system.
|
Package engine contains the core business rules and entities of the system. |
|
Package infrastructure contains all technical adapters such as persistence, storage, authentication, transports (gRPC, HTTP, WebSocket), logging, telemetry, and config management.
|
Package infrastructure contains all technical adapters such as persistence, storage, authentication, transports (gRPC, HTTP, WebSocket), logging, telemetry, and config management. |
|
transport/mdns
Package based around [RFC6762](https://datatracker.ietf.org/doc/html/rfc6762)
|
Package based around [RFC6762](https://datatracker.ietf.org/doc/html/rfc6762) |
|
vttrpg/uvtt
uvtt is the package that holds all the universal virtual table top format
|
uvtt is the package that holds all the universal virtual table top format |
|
Package pkg contains project-wide reusable utilities and extensions.
|
Package pkg contains project-wide reusable utilities and extensions. |
|
proto
|
|
|
scripts
|
|
|
documentation
command
|
|
|
tests
|
|
Click to show internal directories.
Click to hide internal directories.