-
Notifications
You must be signed in to change notification settings - Fork 16
Nextjs readme #272
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Nextjs readme #272
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| # Open Elements Website | ||
|
|
||
| This repository contains the Open Elements website. | ||
| This repository contains the Open Elements website built with Next.js and Tailwind CSS, with legacy Hugo content kept for migration and historical content. | ||
|
|
||
| ## Architecture (2026) | ||
|
|
||
| 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. | ||
| 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. | ||
|
|
||
| ### Runtime layers | ||
|
|
||
|
|
@@ -58,8 +58,36 @@ pnpm run build | |
| pnpm run start | ||
| ``` | ||
|
|
||
| ### Lint | ||
|
|
||
| ``` | ||
| pnpm run lint | ||
| ``` | ||
|
|
||
| ### E2E tests | ||
|
|
||
| ``` | ||
| pnpm run test:e2e | ||
| ``` | ||
|
|
||
| ## Repo structure | ||
|
|
||
| ``` | ||
| src/app Next.js App Router pages & layouts | ||
| src/components UI components | ||
| src/i18n next-intl routing/messages helpers | ||
| locales Translation JSON files | ||
| content Legacy Hugo Markdown content | ||
| src/layouts Legacy Hugo templates | ||
| public Static assets and generated artifacts | ||
| react-src Web components source (bundled to public/js) | ||
| tests/e2e Playwright specs | ||
| ``` | ||
|
|
||
| ## Web components build | ||
|
|
||
| Custom elements in `react-src` are bundled with esbuild via `react-src/build.mjs` into `public/js`. This output is treated as generated code. | ||
|
||
|
|
||
| ## Deployment | ||
|
|
||
| Netlify builds run `pnpm install` and `pnpm run build` (see `netlify.toml`). | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrase "with legacy Hugo content kept for migration and historical content" is redundant, using "content" twice in close proximity. Consider rephrasing to "with legacy Hugo content kept for migration and historical reference" or "with legacy Hugo content retained for migration purposes".