Sanaei
f727d04f65
CI / go-test (push) Canceled after 0s
CI / postgres-durable-first (push) Canceled after 0s
CI / codegen (push) Canceled after 0s
CI / govulncheck (push) Canceled after 0s
CI / race (push) Canceled after 0s
CI / fuzz-smoke (push) Canceled after 0s
CI / golangci (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CodeQL Advanced / Analyze (go) (push) Canceled after 0s
CodeQL Advanced / Analyze (actions) (push) Canceled after 0s
CodeQL Advanced / Analyze (javascript-typescript) (push) Canceled after 0s
Docs CI / build (push) Canceled after 0s
Docs Deploy (GitHub Pages) / build (push) Canceled after 0s
Release 3X-UI / build (386) (push) Canceled after 0s
Release 3X-UI / build (amd64) (push) Canceled after 0s
Release 3X-UI / build (arm64) (push) Canceled after 0s
Release 3X-UI / build (armv5) (push) Canceled after 0s
Release 3X-UI / build (armv6) (push) Canceled after 0s
Release 3X-UI / build (armv7) (push) Canceled after 0s
Release 3X-UI / build (s390x) (push) Canceled after 0s
Release 3X-UI / Build for Windows (amd64) (push) Canceled after 0s
Deploy Smoke Tests / noninteractive-install (ubuntu-24.04-arm) (push) Canceled after 0s
Deploy Smoke Tests / noninteractive-install (ubuntu-latest) (push) Canceled after 0s
Deploy Smoke Tests / release-tag-install (ubuntu-24.04-arm) (push) Canceled after 0s
Deploy Smoke Tests / release-tag-install (ubuntu-latest) (push) Canceled after 0s
Docs Deploy (GitHub Pages) / deploy (push) Canceled after 0s
Release 3X-UI / Publish rolling dev release (push) Canceled after 0s
1.4 KiB
1.4 KiB
Contributing to 3x-ui-docs
Thanks for helping improve the 3x-ui documentation and product site!
Prerequisites
This project uses pnpm (not npm — package-lock.json is
gitignored). Install dependencies and start the dev server:
pnpm install
pnpm dev # http://localhost:3000
Scripts
| Script | Description |
|---|---|
pnpm dev |
Start the dev server |
pnpm build |
Production build |
pnpm start |
Serve the production build |
pnpm typecheck |
Generate MDX/route types and run tsc --noEmit |
pnpm lint |
oxlint (.oxlintrc.json) |
pnpm format |
Format with oxfmt (.oxfmtrc.json) |
pnpm test |
Run unit tests (Vitest) for lib/xray/* pure logic |
pnpm gen:api |
Generate the API reference from public/openapi.json |
Before opening a pull request, please run pnpm typecheck, pnpm lint, pnpm format:check, and
pnpm test — these are the same checks that CI runs on every PR.
License
By contributing, you agree that your contributions will be licensed under the project's GPL-3.0 license.