toeverything/AFFiNE
1
1
Fork 0
mirror of https://github.com/toeverything/AFFiNE.git synced 2024-12-28 10:26:18 +03:00
Code Issues Packages Projects Releases Wiki Activity
8dc022c808
AFFiNE/apps/web
History
sheben 8dc022c808
refactor: use useRouterHelper (#1422) 
Co-authored-by: himself65 <himself65@outlook.com>
2023-03-08 22:58:20 +00:00
..
public refactor!: next generation AFFiNE code structure (#1176) 2023-03-01 15:40:01 +08:00
scripts refactor!: next generation AFFiNE code structure (#1176) 2023-03-01 15:40:01 +08:00
src refactor: use useRouterHelper (#1422) 2023-03-08 22:58:20 +00:00
.env.local.template feat: improve provider testing (#1280) 2023-03-02 20:00:56 -06:00
.eslintrc chore: unify version (#1123) 2023-02-19 08:40:39 +00:00
next-env.d.ts chore: move client folders (#948) 2023-02-10 12:41:01 +00:00
next.config.mjs feat: support code coverage (#1414) 2023-03-08 02:29:50 -06:00
package.json chore: bump version (#1404) 2023-03-08 09:50:58 +00:00
preset.config.mjs feat: improve provider testing (#1280) 2023-03-02 20:00:56 -06:00
README.md docs: update README.md (#1327) 2023-03-05 12:18:56 -06:00
tsconfig.json refactor!: next generation AFFiNE code structure (#1176) 2023-03-01 15:40:01 +08:00

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.