AFFiNE/apps/web/README.md

AFFiNE Web

This is the web application for AFFiNE. It is a React application that uses the Next.js framework.

Getting Started

First, run the development server:

pnpm run dev

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

You can start editing the page by modifying src/pages/workspace/[workspaceId]/all.tsx. The page auto-updates as you edit the file.

For more information on Next.js, take a look at the Next.js Documentation.

Build Presets

preset.config.mjs contains the build presets for the application. The presets are used to configure the build process for different environments. The presets are:

• enableIndexedDBProvider: Enables the IndexedDB provider for the application. This is used to store data in the browser.
• enableBroadCastChannelProvider: Enables the Broadcast Channel provider for the application. This is used to communicate between local browser tabs.
• prefetchWorkspace: deprecated
• exposeInternal: Exposes internal variables into globalThis for debugging purposes.
• enableDebugPage: Enables the debug page for the application. This is used for debugging purposes.

BlockSuite Integration

Set LOCAL_BLOCK_SUITE=/path/to/blocksuite to use a local version of BlockSuite. This is useful for development.