vrr/open-code-review
2
0
Fork 0
mirror of https://github.com/alibaba/open-code-review.git synced 2026-08-12 10:14:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
open-code-review/pages
History
Exact
nolanchic b21cee0843
docs(pages): sync review-rules table with system_rules.json and add ru locale (#612) 
The "Rule resolution per file" table in en/ja/zh was missing 11 entries
(go, astro, python, protobuf, po, pot, graphql, prisma, julia, terraform,
bicep) that exist in internal/config/rules/system_rules.json. Rows are now
ordered to match the declaration order in system_rules.json.

Also adds pages/src/content/docs/ru/review-rules.md, translating the full
page to Russian (the ru locale only had installation.md and quickstart.md
so far) and registers it in the docs index so the ru site shows the
translated page instead of the English fallback.

Closes #608
2026-07-31 10:58:04 +08:00
..
public feat(pages): add social preview meta tags and og-image (#414) 2026-07-21 14:33:27 +08:00
src docs(pages): sync review-rules table with system_rules.json and add ru locale (#612) 2026-07-31 10:58:04 +08:00
.gitignore feat: init 2026-05-20 22:03:52 +08:00
eslint.config.js ci(pages): add ESLint and bundle size check to CI pipeline (#558) 2026-07-28 20:19:37 +08:00
index.html feat(pages): add social preview meta tags and og-image (#414) 2026-07-21 14:33:27 +08:00
logo.svg feat: update brand assets (#257) 2026-07-01 19:09:42 +08:00
package.json improve(pages): simplify ErrorBoundary reload UX and add unit tests (#565) 2026-07-29 10:33:03 +08:00
postcss.config.cjs ci(pages): add ESLint and bundle size check to CI pipeline (#558) 2026-07-28 20:19:37 +08:00
README.md docs(pages): add landing page development guide (#270) 2026-07-02 16:36:54 +08:00
tailwind.config.cjs ci(pages): add ESLint and bundle size check to CI pipeline (#558) 2026-07-28 20:19:37 +08:00
tsconfig.json feat: init 2026-05-20 22:03:52 +08:00
vitest.config.ts improve(pages): simplify ErrorBoundary reload UX and add unit tests (#565) 2026-07-29 10:33:03 +08:00
vitest.setup.ts improve(pages): simplify ErrorBoundary reload UX and add unit tests (#565) 2026-07-29 10:33:03 +08:00
webpack.config.cjs ci(pages): add ESLint and bundle size check to CI pipeline (#558) 2026-07-28 20:19:37 +08:00

README.md

OpenCodeReview Landing Page (pages/)

This directory contains the OpenCodeReview landing page, built with TypeScript, React, Webpack, and Tailwind CSS.

Getting Started

Prerequisites

  • Node.js >=18 (recommended: latest LTS)
  • npm (comes with Node.js) or pnpm

Install dependencies

From the pages/ directory:

npm install

Or with pnpm:

pnpm install

Start local dev server

npx webpack serve

Equivalent npm script:

npm run dev

Default dev server settings (from webpack.config.js):

  • URL: http://localhost:3030
  • Host: 0.0.0.0
  • Port: 3030

Build for production

npx webpack

Project script (recommended, sets production mode):

npm run build

Build output is generated in pages/dist/.

Type checking

npm run typecheck

Project Structure

pages/
├── src/                # React + TypeScript source code
│   ├── components/     # Reusable UI components
│   ├── pages/          # Route-level page components
│   ├── i18n/           # Localization resources and i18n context
│   ├── styles/         # Global styles (Tailwind entry, custom CSS)
│   └── index.tsx       # Frontend entry point
├── dist/               # Production build artifacts (generated)
├── index.html          # HTML template used by HtmlWebpackPlugin
├── webpack.config.js   # Bundling + dev server config
├── tailwind.config.js  # Tailwind theme/content configuration
├── postcss.config.js   # PostCSS pipeline (Tailwind + Autoprefixer)
├── tsconfig.json       # TypeScript compiler options
└── package.json        # Dependencies and scripts

Development Guidelines

PR screenshots are required

Any PR that changes files in pages/ must include before/after screenshots of affected views in the PR description.

Please include:

  • What page/section changed
  • Before screenshot
  • After screenshot
  • Desktop or mobile context (if responsive behavior changed)

Code style and formatting

  • Follow existing TypeScript + React style in this directory.
  • Keep components focused and readable; prefer splitting large JSX blocks into smaller components.
  • Prefer utility-first Tailwind classes and reuse existing design tokens from tailwind.config.js.
  • Keep imports and file naming consistent with surrounding code.
  • Run npm run typecheck before opening a PR.

Tailwind CSS configuration notes

  • Tailwind config is in tailwind.config.js.
  • Content scanning targets:
    • ./src/**/*.{ts,tsx}
    • ./index.html
  • PostCSS integration is configured in postcss.config.js with:
    • tailwindcss
    • autoprefixer

TypeScript configuration notes

  • TypeScript config is in tsconfig.json.
  • Important defaults:
    • strict: true
    • jsx: react-jsx
    • target: ES2020
    • noEmit: true (Webpack handles output)

Suggested PR Checklist

  • Dependencies installed and project runs locally
  • npm run typecheck passes
  • npm run build succeeds
  • Before/after screenshots added to PR
  • Scope is limited to one logical change