AFFiNE Docs
Search…
🌳
Setup

Pre-requisites

Before you follow the rest of this guide you'll want to make sure you have installed Node.js (>=16) and pnpm. You'll also need Git setup to pull our source code from GitHub.
We also recommend using an IDE, such as VSCode, and the nx console plugin is recommended for creating dependencies.

Installation

Clone our GitHub
git clone https://github.com/toeverything/AFFiNE.git
Select the master branch
cd AFFiNE && git checkout master
Install dependencies
pnpm install
Start AFFiNE
pnpm start
Default settings will run AFFiNE on localhost, port 4200 - http://localhost:4200

Further Steps

The .env.local file can be found in the project folder. You can add the following variable to enable the development environment.
NODE_ENV=development
For git-cz functionality, please install the corresponding dependencies globally.
npm install -g commitizen conventional-changelog conventional-changelog-cli
Copy link
Outline
Pre-requisites
Installation
Further Steps