Skip to content

Commit 61a43da

Browse files
committed
docs: update README to clarify project structure and deployment process
Signed-off-by: Daniel Ntege <danientege785@gmail.com>
1 parent a8d56a2 commit 61a43da

1 file changed

Lines changed: 30 additions & 2 deletions

File tree

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Open Elements Website
22

3-
This repository contains the Open Elements website.
3+
This repository contains the Open Elements website built with Next.js and Tailwind CSS, with legacy Hugo content kept for migration and historical content.
44

55
## Architecture (2026)
66

7-
The project is now a Next.js application with App Router, Tailwind CSS, and `next-intl` for i18n. Legacy Hugo content and templates are still kept in the repo for migration and historical content.
7+
The project is a Next.js application using App Router, Tailwind CSS, and `next-intl` for i18n. Legacy Hugo content and templates are kept in the repo for migration and historical content.
88

99
### Runtime layers
1010

@@ -58,8 +58,36 @@ pnpm run build
5858
pnpm run start
5959
```
6060

61+
### Lint
62+
63+
```
64+
pnpm run lint
65+
```
66+
6167
### E2E tests
6268

6369
```
6470
pnpm run test:e2e
6571
```
72+
73+
## Repo structure
74+
75+
```
76+
src/app Next.js App Router pages & layouts
77+
src/components UI components
78+
src/i18n next-intl routing/messages helpers
79+
locales Translation JSON files
80+
content Legacy Hugo Markdown content
81+
src/layouts Legacy Hugo templates
82+
public Static assets and generated artifacts
83+
react-src Web components source (bundled to public/js)
84+
tests/e2e Playwright specs
85+
```
86+
87+
## Web components build
88+
89+
Custom elements in `react-src` are bundled with esbuild via `react-src/build.mjs` into `public/js`. This output is treated as generated code.
90+
91+
## Deployment
92+
93+
Netlify builds run `pnpm install` and `pnpm run build` (see `netlify.toml`).

0 commit comments

Comments
 (0)