2023-04-09 00:33:58 +03:00
|
|
|
# Tutorial
|
|
|
|
|
|
|
|
|
|
## Introduction
|
|
|
|
|
|
|
|
|
|
This tutorial will walk you through the codebase of AFFiNE. It is intended for new contributors to AFFiNE.
|
|
|
|
|
|
|
|
|
|
## Building the project
|
|
|
|
|
|
|
|
|
|
Make sure you know how to build the project. See [BUILDING](../BUILDING.md) for more information.
|
|
|
|
|
|
|
|
|
|
For the debugging purpose, you might need use local OctoBase on port 3000.
|
|
|
|
|
|
|
|
|
|
## Codebase overview
|
|
|
|
|
|
|
|
|
|
The codebase is organized as follows:
|
|
|
|
|
|
2023-10-18 18:30:08 +03:00
|
|
|
- `packages/` contains all code running in production.
|
|
|
|
|
- `backend/` contains backend code, more information from <https://github.com/toeverything/OctoBase>.
|
|
|
|
|
- `frontend/` contains frontend code, including the web app, the electron app and business libraries.
|
|
|
|
|
- `plugins/` contains all build-in plugins.
|
|
|
|
|
- `common` contains the isomorphic code or basic libraries without business.
|
|
|
|
|
- `tools/` contains tools to help developing or CI, not used in production.
|
|
|
|
|
- `tests/` contains testings across different libraries, including e2e testings and integration testings.
|
2023-04-09 00:33:58 +03:00
|
|
|
|
|
|
|
|
### `@affine/env`
|
|
|
|
|
|
|
|
|
|
Environment setup for AFFiNE client side.
|
|
|
|
|
|
|
|
|
|
It includes the global constants, browser and system check.
|
|
|
|
|
|
|
|
|
|
This package should be imported at the very beginning of the entry point.
|
|
|
|
|
|
|
|
|
|
### `@affine/workspace`
|
|
|
|
|
|
|
|
|
|
Current we have two workspace plugin:
|
|
|
|
|
|
|
|
|
|
- `local` for local workspace, which is the default workspace type.
|
|
|
|
|
- `affine` for cloud workspace, which is the workspace type for AFFiNE Cloud with OctoBase backend.
|
|
|
|
|
|
|
|
|
|
#### Design principles
|
|
|
|
|
|
|
|
|
|
- Each workspace plugin has its state and is isolated from other workspace plugins.
|
|
|
|
|
- The workspace plugin is responsible for its own state management, data persistence, synchronization, data backup and recovery.
|
|
|
|
|
|
2023-10-18 18:30:08 +03:00
|
|
|
For the workspace API, see [types.ts](../../packages/frontend/workspace/src/type.ts).
|
2023-04-09 00:33:58 +03:00
|
|
|
|
|
|
|
|
### `@affine/component`
|
|
|
|
|
|
|
|
|
|
The UI component library for AFFiNE.
|
|
|
|
|
|
|
|
|
|
Each component should be a standalone component which can be used in any context, like the Storybook.
|
|
|
|
|
|
|
|
|
|
## Debugging Environments
|
|
|
|
|
|
|
|
|
|
### `@affine/env`
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
yarn dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### `@affine/electron`
|
|
|
|
|
|
|
|
|
|
See [building desktop client app](../building-desktop-client-app.md).
|
|
|
|
|
|
2023-06-07 11:55:06 +03:00
|
|
|
### `@affine/storybook`
|
2023-04-09 00:33:58 +03:00
|
|
|
|
|
|
|
|
```shell
|
2023-06-07 11:55:06 +03:00
|
|
|
yarn workspace @affine/storybook storybook
|
2023-04-09 00:33:58 +03:00
|
|
|
```
|
2023-04-15 08:08:03 +03:00
|
|
|
|
|
|
|
|
## What's next?
|
|
|
|
|
|
|
|
|
|
- [Behind the code](./behind-the-code.md)
|
