mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-02-14 13:25:12 +00:00
406460a3af
Currently, directly running `yarn dev` in `packages/backend/server` (following `developing-server.md`) instead of `yarn affine server dev` would raise following error:
``` sh
server git:(canary) ✗ yarn dev
[nodemon] 3.1.9
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: ts,json
[nodemon] starting `node ./src/index.ts`
node:internal/modules/esm/get_format:160
throw new ERR_UNKNOWN_FILE_EXTENSION(ext, filepath);
^
TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".ts" for /Users/ewind/code/AFFiNE/packages/backend/server/src/index.ts
at Object.getFileProtocolModuleFormat [as file:] (node:internal/modules/esm/get_format:160:9)
at defaultGetFormat (node:internal/modules/esm/get_format:203:36)
at defaultLoad (node:internal/modules/esm/load:141:22)
at async ModuleLoader.load (node:internal/modules/esm/loader:409:7)
at async ModuleLoader.moduleProvider (node:internal/modules/esm/loader:291:45)
at async link (node:internal/modules/esm/module_job:76:21) {
code: 'ERR_UNKNOWN_FILE_EXTENSION'
}
Node.js v20.10.0
[nodemon] app crashed - waiting for file changes before starting...
```
79 lines
1.6 KiB
Markdown
79 lines
1.6 KiB
Markdown
This document explains how to start server (@affine/server) locally with Docker
|
|
|
|
> **Warning**:
|
|
>
|
|
> This document is not guaranteed to be up-to-date.
|
|
> If you find any outdated information, please feel free to open an issue or submit a PR.
|
|
|
|
## Run required dev services in docker compose
|
|
|
|
Running yarn's server package (@affine/server) requires some dev services to be running, i.e.:
|
|
|
|
- postgres
|
|
- redis
|
|
- mailhog
|
|
|
|
You can run these services in docker compose by running the following command:
|
|
|
|
```sh
|
|
cp ./.docker/dev/compose.yml.example ./.docker/dev/compose.yml
|
|
cp ./.docker/dev/.env.example ./.docker/dev/.env
|
|
|
|
docker compose -f ./.docker/dev/compose.yml up
|
|
```
|
|
|
|
## Build native packages (you need to setup rust toolchain first)
|
|
|
|
Server also requires native packages to be built, you can build them by running the following command:
|
|
|
|
```sh
|
|
# build native
|
|
yarn affine @affine/server-native build
|
|
```
|
|
|
|
## Prepare dev environment
|
|
|
|
```sh
|
|
cd packages/backend/server
|
|
|
|
# uncomment all env variables here
|
|
cp .env.example .env
|
|
yarn prisma db push
|
|
yarn data-migration run
|
|
```
|
|
|
|
## Start server
|
|
|
|
```sh
|
|
# at project root
|
|
yarn affine server dev
|
|
```
|
|
|
|
when server started, it will created a default user for testing:
|
|
|
|
- email: dev@affine.pro
|
|
- name: Dev User
|
|
- password: dev
|
|
|
|
## Start frontend
|
|
|
|
```sh
|
|
# at project root
|
|
yarn dev
|
|
```
|
|
|
|
You can login with the user (dev@affine.pro / dev) above to test the server.
|
|
|
|
## Done
|
|
|
|
Now you should be able to start developing affine with server enabled.
|
|
|
|
## Bonus
|
|
|
|
### Enable prisma studio (Database GUI)
|
|
|
|
```sh
|
|
# available at http://localhost:5555
|
|
yarn prisma studio
|
|
```
|