Developer guide
AFFiNE changes quickly. Use this section to choose the right development target, then follow the linked guide in the AFFiNE canary branch for version-sensitive setup.
Choose a target
| Target | Authoritative guide |
|---|---|
| Web app and editor | Building AFFiNE Web |
| Server and cloud features | Developing the server |
| Desktop client | Building the desktop client |
| iOS | iOS package guide |
| Android | Android package guide |
| Documentation site | Documentation contribution workflow |
Common baseline
- Create work from
canary, the development branch. - Use the Node version in
.nvmrc, the Yarn version pinned bypackage.json, and the Rust toolchain pinned by the repository. - Install dependencies with Yarn, then build only the native packages required by your target.
- Run
yarn lint,yarn typecheck, and the tests relevant to your change before opening a pull request.
See Project map for repository orientation, Architecture for code boundaries, and Contributing for the complete pull request flow.
ON THIS PAGE