# csouzaalbertob-commits/palavreando architecture

> Architecture diagram of the GitHub repository csouzaalbertob-commits/palavreando, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/csouzaalbertob-commits/palavreando
- Repository: https://github.com/csouzaalbertob-commits/palavreando

## Overview

Palavreando is a Django educational application for managing schools and students and running literacy activities. The main workflow is a teacher managing student records, selecting an activity, and saving performance data for review. The README also documents access control and school-census data, but the tree contains no census app, so that capability is not mapped as an implemented subsystem. The excerpts show activity views and models, student results, WebSocket routing, and a scheduled export entry point; several other integrations and route connections remain unverified.

Main entry points: [`palavra/views.py`](https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/views.py) (Activity Views), [`alunos/views.py`](https://github.com/csouzaalbertob-commits/palavreando/blob/main/alunos/views.py) (Student Management), [`palavra/consumers.py`](https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/consumers.py) (Battle WebSocket), [`autentica/models.py`](https://github.com/csouzaalbertob-commits/palavreando/blob/main/autentica/models.py) (School Structure)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_identity["Identity and Schools"]
  node_auth["Access Control<br/>[views.py]"]
  node_school[("School Structure<br/>[models.py]")]
end

subgraph group_students["Student Records"]
  node_student_views["Student Management<br/>[views.py]"]
  node_student_data[("Students and Results<br/>[models.py]")]
end

subgraph group_literacy["Literacy Activities"]
  node_literacy_views["Activity Views<br/>[views.py]"]
  node_vocabulary[("Words and Phrases<br/>[models.py]")]
  node_listening[("Listen and Speak<br/>[models.py]")]
  node_battle[("Battle Activity<br/>[models.py]")]
  node_dictation[("Dictation<br/>[models.py]")]
  node_stories[("Stories and Comprehension<br/>[models.py]")]
  node_auth_ws["Access WebSockets<br/>[consumers.py]"]
  node_word_ws["Battle WebSocket<br/>[consumers.py]"]
end

subgraph group_operations["Reporting and Operations"]
  node_asgi["ASGI Routing<br/>[asgi.py]"]
  node_export["Performance Export"]
end

node_teacher(("Teacher"))
node_mail["Email Service"]

node_teacher -->|"signs in"| node_auth
node_teacher -->|"manages students"| node_student_views
node_teacher -->|"runs activities"| node_literacy_views
node_student_views -->|"looks up school"| node_school
node_student_views -->|"creates and queries"| node_student_data
node_literacy_views -->|"loads students and reading results"| node_student_data
node_literacy_views -->|"loads words"| node_vocabulary
node_literacy_views -->|"saves results"| node_listening
node_literacy_views -->|"queries matches"| node_battle
node_literacy_views -->|"records comprehension"| node_stories
node_asgi -->|"routes sockets"| node_word_ws
node_word_ws -->|"uses battle models"| node_battle
node_auth_ws -.-> node_school
node_export -->|"sends export"| node_mail

click node_auth "https://github.com/csouzaalbertob-commits/palavreando/blob/main/autentica/views.py"
click node_school "https://github.com/csouzaalbertob-commits/palavreando/blob/main/autentica/models.py"
click node_student_views "https://github.com/csouzaalbertob-commits/palavreando/blob/main/alunos/views.py"
click node_student_data "https://github.com/csouzaalbertob-commits/palavreando/blob/main/alunos/models.py"
click node_literacy_views "https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/views.py"
click node_vocabulary "https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/models.py"
click node_listening "https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/models.py"
click node_battle "https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/models.py"
click node_dictation "https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/models.py"
click node_stories "https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/models.py"
click node_auth_ws "https://github.com/csouzaalbertob-commits/palavreando/blob/main/autentica/consumers.py"
click node_word_ws "https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/consumers.py"
click node_asgi "https://github.com/csouzaalbertob-commits/palavreando/blob/main/sistema/asgi.py"
click node_export "https://github.com/csouzaalbertob-commits/palavreando/blob/main/sistema/exportacao_dados.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_auth,node_school toneBlue
class node_student_views,node_student_data toneAmber
class node_literacy_views,node_vocabulary,node_listening,node_battle,node_dictation,node_stories,node_auth_ws,node_word_ws toneMint
class node_asgi,node_export toneRose
class node_teacher,node_mail toneIndigo
```

## Components

### Identity and Schools

- [Access Control](https://github.com/csouzaalbertob-commits/palavreando/blob/main/autentica/views.py): `autentica/views.py`
- [School Structure](https://github.com/csouzaalbertob-commits/palavreando/blob/main/autentica/models.py): `autentica/models.py`

### Student Records

- [Student Management](https://github.com/csouzaalbertob-commits/palavreando/blob/main/alunos/views.py): `alunos/views.py`
- [Students and Results](https://github.com/csouzaalbertob-commits/palavreando/blob/main/alunos/models.py): `alunos/models.py`

### Literacy Activities

- [Activity Views](https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/views.py): `palavra/views.py`
- [Words and Phrases](https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/models.py): `palavra/models.py`
- [Listen and Speak](https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/models.py): `palavra/models.py`
- [Battle Activity](https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/models.py): `palavra/models.py`
- [Dictation](https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/models.py): `palavra/models.py`
- [Stories and Comprehension](https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/models.py): `palavra/models.py`
- [Access WebSockets](https://github.com/csouzaalbertob-commits/palavreando/blob/main/autentica/consumers.py): `autentica/consumers.py`
- [Battle WebSocket](https://github.com/csouzaalbertob-commits/palavreando/blob/main/palavra/consumers.py): `palavra/consumers.py`

### Reporting and Operations

- [ASGI Routing](https://github.com/csouzaalbertob-commits/palavreando/blob/main/sistema/asgi.py): `sistema/asgi.py`
- [Performance Export](https://github.com/csouzaalbertob-commits/palavreando/blob/main/sistema/exportacao_dados.py): `sistema/exportacao_dados.py`

### Other components

- **Teacher**
- **Email Service**

## Connections

- Teacher → Access Control: signs in
- Teacher → Student Management: manages students
- Teacher → Activity Views: runs activities
- Student Management → School Structure: looks up school (evidence: `alunos/views.py`)
- Student Management → Students and Results: creates and queries (evidence: `alunos/views.py`)
- Activity Views → Students and Results: loads students and reading results (evidence: `palavra/views.py`)
- Activity Views → Words and Phrases: loads words (evidence: `palavra/views.py`)
- Activity Views → Listen and Speak: saves results (evidence: `palavra/views.py`)
- Activity Views → Battle Activity: queries matches (evidence: `palavra/views.py`)
- Activity Views → Stories and Comprehension: records comprehension (evidence: `palavra/views.py`)
- ASGI Routing → Battle WebSocket: routes sockets (evidence: `sistema/asgi.py`)
- Battle WebSocket → Battle Activity: uses battle models (evidence: `palavra/consumers.py`)
- Access WebSockets → School Structure
- Performance Export → Email Service: sends export (evidence: `sistema/exportacao_dados.py`)
