Skip to content

Commit e828223

Browse files
authored
Merge pull request #76 from ebouchut/design-frontend-foundation
frontend: Add Wireframes and Mockups
2 parents 0d61e37 + 98f3a8c commit e828223

21 files changed

Lines changed: 6081 additions & 0 deletions

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,27 @@ Registration (`POST /auth/register`) is handled by `AuthController` and
113113
`RegistrationService` (server-side bean validation plus duplicate
114114
username/email detection).
115115

116+
#### Design: Mockups and Wireframes
117+
118+
The frontend look and feel is specified before code:
119+
120+
- **[Figma file](https://www.figma.com/design/2q1Rt5NGbQ1w8gRtRGoF4A)**
121+
(read-only): low-fidelity wireframes (page structure) and high-fidelity
122+
mockups (Catppuccin theme).
123+
- **[Browsable HTML mockups](docs/design/mockups/index.html)**: the same
124+
pages as static HTML/CSS; their markup and BEM classes are the blueprint
125+
for the future Thymeleaf templates.
126+
- **[docs/design/theme-exploration.md](docs/design/theme-exploration.md)**:
127+
the design tokens and their WCAG contrast ratios;
128+
[mockups-explained.md](docs/design/mockups-explained.md)
129+
(FR: [mockups-explained-fr.md](docs/design/mockups-explained-fr.md)) and
130+
the per-file docs in [docs/design/mockups/](docs/design/mockups/) explain
131+
every tag and CSS rule.
132+
133+
Frontend contributions are expected to follow the mockups, consume colors
134+
only through the design tokens, and use the BEM naming convention (see
135+
[Code Style and Formatting](#code-style-and-formatting)).
136+
116137
#### MonoRepo
117138

118139
We use a **monorepo**, that is a Git repository containing mainly both the **frontend and** the **backend**.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,12 @@ visit [this link](https://github.com/users/ebouchut/projects/7/views/3).
379379
- [GLOSSARY.md](GLOSSARY.md) — definitions of the domain and technical terms used across the project
380380
(🇫🇷 French version: [GLOSSAIRE.md](GLOSSAIRE.md)).
381381
- [Architecture Decision Records](docs/adr/README.md) — A list of design decisions and their trade-offs.
382+
- [Mockups and wireframes (Figma)](https://www.figma.com/design/2q1Rt5NGbQ1w8gRtRGoF4A) —
383+
read-only Figma file with the high-fidelity mockups (Catppuccin theme) and the
384+
low-fidelity wireframes of the frontend pages; the browsable HTML mockups and
385+
their study docs live in [docs/design/](docs/design/theme-exploration.md)
386+
(see [mockups-explained.md](docs/design/mockups-explained.md),
387+
🇫🇷 [mockups-explained-fr.md](docs/design/mockups-explained-fr.md)).
382388
- [Test coverage (Codecov)](https://app.codecov.io/gh/ebouchut/learn-dev) —
383389
live coverage dashboard fed by CI
384390
(see [ADR-0012](docs/adr/0012-publish-test-coverage-to-codecov.md));

docs/design/mockups-explained-fr.md

Lines changed: 676 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)