Barazo lexicon schemas and TypeScript types
barazo.forum
docs: add status, context, and related repos to README (#8)
Add alpha status line, explanatory "What is this?" section, and
related repositories section.
authored by
Guido X Jansen
and committed by
GitHub
2600da71
0c1dedf9
+19
+19
README.md
+19
README.md
···
2
2
3
3
AT Protocol lexicon schemas and generated TypeScript types for the Barazo forum platform. Defines the `forum.barazo.*` namespace with record types for topics, replies, reactions, and user preferences.
4
4
5
+
**Status:** Alpha -- All MVP lexicon schemas defined, published to GitHub Packages
6
+
7
+
## What is this?
8
+
9
+
Lexicons are AT Protocol schemas that define the data model for Barazo forums. They specify what a topic, reply, reaction, and user preferences record looks like in the AT Protocol ecosystem. These schemas are the contract between the user's PDS (Personal Data Server) and the Barazo AppView, ensuring all forum data is portable and interoperable.
10
+
11
+
This package provides:
12
+
- JSON lexicon schema files (the source of truth)
13
+
- Generated TypeScript types with type guards and validators
14
+
- Zod validation schemas for runtime input validation
15
+
- Lexicon IDs as constants
16
+
5
17
## Installation
6
18
7
19
For npm consumers outside the workspace, configure GitHub Packages access in `.npmrc`:
···
101
113
pnpm lint # Lint
102
114
pnpm typecheck # Type check
103
115
```
116
+
117
+
## Related Repositories
118
+
119
+
- **[barazo-api](https://github.com/barazo-forum/barazo-api)** -- Backend (AGPL-3.0)
120
+
- **[barazo-web](https://github.com/barazo-forum/barazo-web)** -- Frontend (MIT)
121
+
- **[barazo-deploy](https://github.com/barazo-forum/barazo-deploy)** -- Deployment templates (MIT)
122
+
- **[Organization](https://github.com/barazo-forum)** -- All repos
104
123
105
124
## License
106
125