mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-07-14 00:26:51 +08:00
docs: update README.md (#1327)
This commit is contained in:
@@ -0,0 +1,31 @@
|
||||
# AFFiNE Web
|
||||
|
||||
This is the web application for AFFiNE. It is a React application that uses the [Next.js](https://nextjs.org/) framework.
|
||||
|
||||
## Getting Started
|
||||
|
||||
First, run the development server:
|
||||
|
||||
```bash
|
||||
pnpm run dev
|
||||
```
|
||||
|
||||
Open [http://localhost:8080](http://localhost:3000) 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](https://nextjs.org/docs).
|
||||
|
||||
## 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](https://github.com/toeverything/blocksuite). This is useful for development.
|
||||
+5
-3
@@ -1,10 +1,10 @@
|
||||
# Building AFFiNE
|
||||
# Building AFFiNE Web
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Setup Environment](#setup-environment)
|
||||
- [Play with Playground](#play-with-playground)
|
||||
- [Start Development Server](#start-development-server)
|
||||
- [Testing](#testing)
|
||||
|
||||
## Prerequisites
|
||||
@@ -33,7 +33,7 @@ nvm use --lts
|
||||
pnpm install
|
||||
```
|
||||
|
||||
## Play with Playground
|
||||
## Start Development Server
|
||||
|
||||
```sh
|
||||
pnpm dev
|
||||
@@ -41,6 +41,8 @@ pnpm dev
|
||||
|
||||
The playground page should work at [http://localhost:8080/](http://localhost:8080/)
|
||||
|
||||
For more details, see [apps/web/README.md](../apps/web/README.md)
|
||||
|
||||
## Testing
|
||||
|
||||
Adding test cases is strongly encouraged when you contribute new features and bug fixes.
|
||||
|
||||
Reference in New Issue
Block a user