필수품

• Node.js (추천 버전의 .nvmrc 참조)

시작하기

첫째, 의존성을 설치하고 개발 서버를 실행:

http://localhost:3000] 브라우저를 열고 결과를 볼 수 있습니다.

Dependency install 스크립트

npm 11.16+ 게이트 종속 수명주기 스크립트 (preinstall / [T2]]] / postinstall]]] allowScripts]] 필드 뒤에 [[T5]: npm 11 warns about unapproved scripts but still running them, npm 12 Skip them. 이 패키지는 프로젝트가 항상 설치되었는지 일치하는 이름 (모든 버전)에 의해 승인됩니다. cypress]는 Cypress 바이너리를 다운로드하기 위해 스크립트를 필요로한다; @sentry/cli 스크립트는 사전 제작 된 플랫폼 패키지가 누락 될 때 작업하는 fallback입니다. browser-tabs-lock]는 메시지 만 인쇄합니다. npm install-scripts prune]를 실행하여 종속 나무를 떠난 패키지에 대한 항목을 드롭합니다. 설치 스크립트에 새로운 의존도는 여전히 파쇄 (npm 11 warns, npm 12 Skips it and install may break); npm install-scripts ls]]로 검토하고 합법적 인 경우 npm install-scripts approve --no-allow-scripts-pin로 추가하십시오.

환경 변수

Pubky web app

Prerequisites

• Node.js (see .nvmrc for the recommended version)

Getting Started

First, install the dependencies and run the development server:

npm install
npm run dev

Open http://localhost:3000 with your browser to see the result.

Dependency install scripts

npm 11.16+ gates dependency lifecycle scripts (preinstall / install / postinstall) behind the allowScripts field in package.json: npm 11 warns about unapproved scripts but still runs them, npm 12 skips them. The packages listed there are approved by name (any version), which matches how the project has always installed. cypress needs its script to download the Cypress binary; the @sentry/cli script is a fallback that only does work when its prebuilt platform package is missing; browser-tabs-lock only prints a message. Run npm install-scripts prune to drop entries for packages that have left the dependency tree. Any new dependency with an install script is still flagged (npm 11 warns, npm 12 skips it and the install may break); review it with npm install-scripts ls and, if it is legitimate, add it with npm install-scripts approve --no-allow-scripts-pin.

Environment Variables

Copy the example environment file and adjust the values as needed:

cp .env.example .env

See docs/environment.md for more details.

Common Workflows

• Check architecture and coding conventions: docs/README.md
• AI-assisted development (Claude Code, Codex, Cursor): start at AGENTS.md; local review skill /pubky-code-review (.agents/skills/pubky-code-review/SKILL.md)
• Follow commit message format: docs/commit-message.md
• Cut a production release: docs/release.md
• Cut a production hotfix: docs/hotfix.md

License

This project is licensed under the MIT License.
See the LICENSE file for more details.