Barazo default frontend
barazo.forum
Merge pull request #27 from barazo-forum/docs/standardize-readme
Standardize README to match org-wide template
authored by
Guido X Jansen
and committed by
GitHub
9b2ae747
05c97f5a
+38
-74
+38
-74
README.md
+38
-74
README.md
···
6
6
<img alt="Barazo Logo" src="https://raw.githubusercontent.com/barazo-forum/.github/main/assets/logo-dark.svg" width="120">
7
7
</picture>
8
8
9
-
# barazo-web
9
+
# Barazo Web
10
10
11
-
**Default frontend for Barazo forums**
11
+
**Default frontend for Barazo forums -- accessible, themeable, replaceable.**
12
12
13
+
[]()
13
14
[](https://opensource.org/licenses/MIT)
15
+
[](https://github.com/barazo-forum/barazo-web/actions/workflows/ci.yml)
14
16
[](https://nodejs.org/)
15
17
[](https://www.typescriptlang.org/)
16
-
[](#testing)
17
18
18
19
</div>
19
20
20
21
---
21
22
22
-
## Status: Alpha
23
-
24
-
Core MVP UI implemented. 356 tests across 47 test files, all passing. WCAG 2.2 AA compliant.
25
-
26
-
**Completed:** P1 (Full forum UI) + P2.1/P2.2 (user preferences, self-labels, block/mute, age gate)
27
-
28
-
---
29
-
30
-
## What is this?
31
-
32
-
The default frontend for Barazo forums. Communicates with the [barazo-api](https://github.com/barazo-forum/barazo-api) backend exclusively via REST API. Forum admins can customize or replace this frontend entirely.
23
+
## Overview
33
24
34
-
- **Server-side rendered** forum UI (topics, replies, categories, profiles, search)
35
-
- **Admin dashboard** (moderation, settings, branding, categories, users, content ratings)
36
-
- **AT Protocol OAuth** login flow (redirects to user's PDS)
37
-
- **Markdown rendering** for post content (sanitized via DOMPurify)
38
-
- **Accessibility-first** -- WCAG 2.2 AA from first commit
25
+
The default frontend for Barazo forums. Communicates with the [barazo-api](https://github.com/barazo-forum/barazo-api) backend exclusively via REST API. Forum admins can customize the theme or replace this frontend entirely. WCAG 2.2 AA compliant from first commit.
39
26
40
27
---
41
28
···
56
43
57
44
---
58
45
59
-
## Implemented Features
46
+
## Features
60
47
61
48
**19 pages:**
62
49
···
102
89
- Sitemap + robots.txt
103
90
- Skip links for keyboard navigation
104
91
92
+
---
93
+
105
94
## Planned Features
106
95
107
96
- Plugin management UI (page exists, functionality pending)
···
112
101
113
102
---
114
103
115
-
## Testing
116
-
117
-
```
118
-
356 tests across 47 test files -- all passing
119
-
```
120
-
121
-
Three-tier accessibility testing:
122
-
123
-
1. **Static analysis:** eslint-plugin-jsx-a11y (strict mode)
124
-
2. **Unit tests:** vitest-axe on rendered components
125
-
3. **Integration:** @axe-core/playwright in CI
126
-
127
-
```bash
128
-
pnpm test # Run all tests
129
-
pnpm lint # ESLint + a11y rules
130
-
pnpm typecheck # TypeScript strict mode
131
-
```
132
-
133
-
---
134
-
135
-
## Prerequisites
136
-
137
-
- Node.js 24 LTS
138
-
- pnpm
139
-
- [barazo-api](https://github.com/barazo-forum/barazo-api) running (or use mock handlers for development)
140
-
141
-
---
142
-
143
104
## Quick Start
144
105
145
-
**Clone and install:**
106
+
**Prerequisites:** Node.js 24 LTS, pnpm, [barazo-api](https://github.com/barazo-forum/barazo-api) running (or mock handlers).
146
107
147
108
```bash
148
109
git clone https://github.com/barazo-forum/barazo-web.git
149
110
cd barazo-web
150
111
pnpm install
151
-
```
152
112
153
-
**Run development server:**
154
-
155
-
```bash
113
+
# Run development server
156
114
pnpm dev
157
115
```
158
116
159
117
Open [http://localhost:3001](http://localhost:3001) to view in the browser.
160
118
161
-
**Run tests:**
119
+
---
120
+
121
+
## Development
162
122
163
123
```bash
164
-
pnpm test
165
-
pnpm lint
166
-
pnpm typecheck
124
+
pnpm test # Run all tests
125
+
pnpm lint # ESLint + a11y rules
126
+
pnpm typecheck # TypeScript strict mode
167
127
```
168
128
169
-
---
129
+
Three-tier accessibility testing:
170
130
171
-
## Development
131
+
1. **Static analysis:** eslint-plugin-jsx-a11y (strict mode)
132
+
2. **Unit tests:** vitest-axe on rendered components
133
+
3. **Integration:** @axe-core/playwright in CI
172
134
173
-
See [CONTRIBUTING.md](https://github.com/barazo-forum/.github/blob/main/CONTRIBUTING.md) for full guidelines.
135
+
See [CONTRIBUTING.md](https://github.com/barazo-forum/.github/blob/main/CONTRIBUTING.md) for branching strategy, commit format, and code review process.
174
136
175
137
**Key standards:**
176
138
···
183
145
184
146
---
185
147
186
-
## License
187
-
188
-
**MIT** -- Encourages customization and theming. Forum admins can build entirely custom frontends.
189
-
190
-
See [LICENSE](LICENSE) for full terms.
191
-
192
-
---
193
-
194
148
## Related Repositories
195
149
196
-
- **[barazo-api](https://github.com/barazo-forum/barazo-api)** -- Backend (AGPL-3.0)
197
-
- **[barazo-lexicons](https://github.com/barazo-forum/barazo-lexicons)** -- AT Protocol schemas (MIT)
198
-
- **[barazo-deploy](https://github.com/barazo-forum/barazo-deploy)** -- Deployment templates (MIT)
199
-
- **[Organization](https://github.com/barazo-forum)** -- All repos
150
+
| Repository | Description | License |
151
+
| ------------------------------------------------------------------ | --------------------------------------------- | -------- |
152
+
| [barazo-api](https://github.com/barazo-forum/barazo-api) | AppView backend (Fastify, firehose, REST API) | AGPL-3.0 |
153
+
| [barazo-lexicons](https://github.com/barazo-forum/barazo-lexicons) | AT Protocol lexicon schemas + generated types | MIT |
154
+
| [barazo-deploy](https://github.com/barazo-forum/barazo-deploy) | Docker Compose deployment templates | MIT |
155
+
| [barazo-website](https://github.com/barazo-forum/barazo-website) | Marketing + documentation site | MIT |
200
156
201
157
---
202
158
203
159
## Community
204
160
205
-
- **Website:** [barazo.forum](https://barazo.forum) (coming soon)
161
+
- **Website:** [barazo.forum](https://barazo.forum)
206
162
- **Discussions:** [GitHub Discussions](https://github.com/orgs/barazo-forum/discussions)
207
163
- **Issues:** [Report bugs](https://github.com/barazo-forum/barazo-web/issues)
208
164
209
165
---
210
166
211
-
(c) 2026 Barazo. Licensed under MIT.
167
+
## License
168
+
169
+
**MIT** -- Encourages customization and theming. Forum admins can build entirely custom frontends.
170
+
171
+
See [LICENSE](LICENSE) for full terms.
172
+
173
+
---
174
+
175
+
(c) 2026 Barazo