Jayden/AFFiNE-Mirror
1
0
Fork 0
mirror of https://github.com/toeverything/AFFiNE.git synced 2026-02-04 08:38:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(core): clarify developing server docs (#9420)

Browse Source
This commit is contained in:
pengx17
2024-12-30 03:51:58 +00:00
parent b9f2650369
commit 87331b49b7
2 changed files with 17 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/developing-server.md
View File

@@ -7,15 +7,25 @@ This document explains how to start server (@affine/server) locally with Docker
## 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 -d
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
@@ -51,6 +61,8 @@ when server started, it will created a default user for testing:
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.