mirror of
https://github.com/alibaba/open-code-review.git
synced 2026-07-09 17:28:58 +00:00
- Increase section height to prevent terminal bottom from being clipped by overflow:hidden - Adjust terminal body bottom padding to 8px for better spacing |
||
|---|---|---|
| .. | ||
| src | ||
| .gitignore | ||
| index.html | ||
| logo.svg | ||
| package.json | ||
| postcss.config.js | ||
| README.md | ||
| tailwind.config.js | ||
| tsconfig.json | ||
| webpack.config.js | ||
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) orpnpm
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 typecheckbefore 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.jswith:tailwindcssautoprefixer
TypeScript configuration notes
- TypeScript config is in
tsconfig.json. - Important defaults:
strict: truejsx: react-jsxtarget: ES2020noEmit: true(Webpack handles output)
Suggested PR Checklist
- Dependencies installed and project runs locally
npm run typecheckpassesnpm run buildsucceeds- Before/after screenshots added to PR
- Scope is limited to one logical change