Getting Started (New Contributors)

May 17, 2026 · View on GitHub

中文

1. Requirements

  • Node.js >= 20
  • Yarn (default package manager in this repo)
  • Git

2. Initialize the project

yarn
cp .env.example .env.local

At minimum, set this in .env.local:

  • NOTION_PAGE_ID

Then start dev server:

yarn dev

yarn lint
yarn type-check
yarn test

4. Read these first

  1. Architecture Overview
  2. Project Structure
  3. Configuration System
  4. Contribution Workflow

5. First contribution advice

  • Start with small scoped fixes (single file/module).
  • Do not mix multiple change types in one PR.
  • Ensure lint/test pass before opening PR.