Mirrored_Repos/AppFlowy
1
0
Fork 0
mirror of https://github.com/AppFlowy-IO/AppFlowy.git synced 2024-08-30 18:12:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #101 from pdckxd/main

Browse Source 
[Instruction] Slightly update steps of BUILD_ON_WINDOWS.md
This commit is contained in:
AppFlowy.IO 2021-11-28 23:13:42 +08:00 committed by GitHub
commit 180b0cd568
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 27 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/BUILD_ON_LINUX.md
View File

@ -64,13 +64,14 @@ cargo install --force cargo-make
```shell
cargo install --force duckscript_cli
```
8. Check pre-request
8. Check prerequisites
```shell
cargo make flowy_dev
```
9. [Optional] Generate protobuf for dart (optional, if you modify the shared-lib's entities)
```shell
# Make sure to install protobuf-compiler at first. See step 1
cargo make -p development-linux-x86 pb
```
10. [Optional] Build flowy-sdk-dev (dart-ffi), step 10 covers this step

13
doc/BUILD_ON_WINDOWS.md
View File

@ -11,7 +11,7 @@ git clone https://github.com/AppFlowy-IO/appflowy.git
------------------------------
Note:
* Please run the commands in windows cmd rather than powershell
* Both Windows cmd and powershell can be used for running commands
* Following steps are verified on
- [x] Windows 10 X86_64
- [ ] Windows 10 arm64
@ -32,7 +32,8 @@ flutter doctor
```shell
# Download rustup.exe from https://win.rustup.rs/x86_64
# Call rustup.exe from powershell or cmd
rustup.exe toolchain install nightly
.\rustup-init.exe --default-toolchain nightly --default-host x86_64-pc-windows-msvc -y
# Note: you probably need to re-open termial to get cargo command be available in PATH var
```
5. Install cargo make
```shell
@ -43,15 +44,17 @@ cargo install --force cargo-make
```shell
cargo install --force duckscript_cli
```
7. Check pre-request
7. Check prerequisites
```shell
cargo make flowy_dev
```
8. [Optional] Generate protobuf for dart (optional, if you modify the shared-lib's entities)
```shell
# Need to download protoc tools and add it's bin folder into PATH env var.
# Download protoc from https://github.com/protocolbuffers/protobuf/releases. The latest one is protoc-3.19.1-win64.zip
cargo make -p development-windows pb
```
9. [Optional] Build flowy-sdk (dart-ffi)
9. [Optional] Build flowy-sdk (dart-ffi), step 10 covers this step
```shell
# for development
cargo make --profile development-windows-x86 flowy-sdk-dev
@ -66,7 +69,7 @@ cargo make -p development-windows-x86 appflowy-windows-dev
cargo make -p production-windows-x86 appflowy-windows
```
## Step 3: Build Server side application (optional if you don't need to host web service locally)
## [Optional] Step 3: Build Server side application (optional if you don't need to host web service locally)
------------------------------
Note: You can launch postgresql server by using docker container

17
frontend/scripts/makefile/protobuf.toml
View File

@ -1,6 +1,19 @@
[tasks.pb]
dependencies = ["gen_pb_file"]
dependencies = ["check_protoc_cmd", "gen_pb_file"]
[tasks.check_protoc_cmd]
script = [
"""
ret = which protoc
if is_empty ${ret}
echo Please make sure <protoc_installation_folder>/bin/ is in PATH env var
echo See BUILD_ON_{LINUX|WINDOWS}.md for how to get protoc
exit -1
end
""",
]
script_runner = "@duckscript"
[tasks.gen_pb_file]
script = [
@ -30,7 +43,7 @@ script = [
flowy_tool=set ${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/scripts/flowy-tool/Cargo.toml
rust_source=set ${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/rust-lib/
# rust_lib=set ${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/rust-lib
shared_lib=${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/../shared-lib
shared_lib=set ${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/../shared-lib
flutter_lib=set ${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/app_flowy/packages
derive_meta=set ${shared_lib}/flowy-derive/src/derive_cache/derive_cache.rs