Skip to content

Commit 6b18fa0

Browse files
authored
docs: Refactor architecture section in README.md
1 parent e2f282a commit 6b18fa0

1 file changed

Lines changed: 1 addition & 51 deletions

File tree

README.md

Lines changed: 1 addition & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -201,57 +201,7 @@ open http://localhost:3333/api-docs
201201

202202

203203
## 03 · Architecture
204-
205-
This API follows a **modular monolith** architecture with the following modules:
206-
207-
<details>
208-
<summary><kbd>▶ See details (click to expand)</kbd></summary>
209-
210-
211-
```
212-
┌─────────────────────────────────────────────────────────────────────────────┐
213-
│ MODULE │ RESPONSIBILITY │
214-
├─────────────────────┼───────────────────────────────────────────────────────┤
215-
│ core │ Shared base classes, concerns and constants │
216-
│ authentication │ User auth and authorization │
217-
│ admin │ Organization, audit log and admin player management │
218-
│ dashboard │ Dashboard statistics and metrics │
219-
│ players │ Player management, rosters and statistics │
220-
│ scouting │ Player scouting and talent discovery │
221-
│ analytics │ Performance, competitive draft, tournament & opponent│
222-
│ matches │ Match data and statistics │
223-
│ schedules │ Event and schedule management │
224-
│ vod_reviews │ Video review and timestamp management │
225-
│ team_goals │ Goal setting and tracking │
226-
│ riot_integration │ Riot Games API integration │
227-
│ competitive │ PandaScore/Grid.gg + Elasticsearch match detail/Draft│
228-
│ meta_intelligence │ Build aggregation, champion/item meta analytics │
229-
│ scrims │ Scrim management and opponent team tracking │
230-
│ strategy │ Draft planning and tactical board system │
231-
│ ai_intelligence │ Champion2Vec embeddings, win probability, ML picks │
232-
│ support │ Support ticket system with staff dashboard and FAQ │
233-
│ messaging │ Real-time team chat via Action Cable WebSocket │
234-
│ search │ Global full-text search powered by Meilisearch │
235-
│ notifications │ In-app notification system │
236-
│ tournaments │ ArenaBR double-elimination tournament management │
237-
└─────────────────────┴───────────────────────────────────────────────────────┘
238-
```
239-
</details>
240-
241-
- `authentication` - User authentication and authorization
242-
- `dashboard` - Dashboard statistics and metrics
243-
- `players` - Player management and statistics
244-
- `scouting` - Player scouting and talent discovery
245-
- `analytics` - Performance analytics and reporting
246-
- `matches` - Match data and statistics
247-
- `schedules` - Event and schedule management
248-
- `vod_reviews` - Video review and timestamp management
249-
- `team_goals` - Goal setting and tracking
250-
- `riot_integration` - Riot Games API integration
251-
- `competitive` - PandaScore integration, pro matches, draft analysis
252-
- `scrims` - Scrim management and opponent team tracking
253-
- `strategy` - Draft planning and tactical board system
254-
- `support` - Support ticket system with staff and FAQ management
204+
255205

256206
### Architecture
257207

0 commit comments

Comments
 (0)