More readme updates.

Signed-off-by: Cliff Hill <xlorep@darkhelm.org>
This commit is contained in:
2025-09-04 08:06:20 -04:00
parent f719187788
commit ee39be5b79

View File

@@ -180,20 +180,35 @@ I would have templates in place for creating a PR, with a set of instructions th
### Diagrams
Docker Compose Components:
#### Docker Compose Components
```mermaid
graph TD
subgraph Docker_Network
B[Frontend] -->|HTTP/REST: Port 8000| C[Backend]
C -->|SQL: Port 5432| D[PostgreSQL]
end
A[World] -->|HTTP: Port 3000| B
subgraph Docker_Network
B[Frontend]
C[Backend]
D[PostgreSQL]
C -- "SQL: 5432" --> D
end
Client[Client] -- "HTTP: 3000" --> B
Client -- "HTTP/REST: 8000" --> C
```
---
## Database Schema Outline
#### Connecting to the Database During Development
When running with `compose.dev.yml`, the database is exposed on port 5432. You can connect using `psql`:
```bash
psql -h localhost -U user -d mydb
```
Enter the password when prompted (see your `.env` file, default is `password`).
---
#### Database Schema Outline
**users**
@@ -225,7 +240,7 @@ graph TD
---
## Component Diagram
#### Component Diagram
```mermaid
graph TD
@@ -244,7 +259,7 @@ graph TD
---
Backend Request Data Path:
#### Backend Request Data Path
```mermaid
sequenceDiagram
@@ -268,5 +283,3 @@ sequenceDiagram
Service_Layer-->>API_Endpoint: Return Response Data
API_Endpoint-->>Frontend: HTTP Response
```
---