chore: update docs (#165)
* chore: update docs * chore: update * chore: update
This commit is contained in:
parent
79a02edd00
commit
147317bd1c
|
|
@ -2694,6 +2694,12 @@ version = "0.8.3"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "e5ce46fe64a9d73be07dcbe690a38ce1b293be448fd8ce1e6c1b8062c9f72c6a"
|
checksum = "e5ce46fe64a9d73be07dcbe690a38ce1b293be448fd8ce1e6c1b8062c9f72c6a"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "mutually_exclusive_features"
|
||||||
|
version = "0.0.3"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "6d02c0b00610773bb7fc61d85e13d86c7858cbdf00e1a120bfc41bc055dbaa0e"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "native-tls"
|
name = "native-tls"
|
||||||
version = "0.2.11"
|
version = "0.2.11"
|
||||||
|
|
@ -5001,11 +5007,12 @@ dependencies = [
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "tracing-actix-web"
|
name = "tracing-actix-web"
|
||||||
version = "0.7.6"
|
version = "0.7.9"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "5c0b08ce08cbde6a96fc1e4ebb8132053e53ec7a5cd27eef93ede6b73ebbda06"
|
checksum = "1fe0d5feac3f4ca21ba33496bcb1ccab58cca6412b1405ae80f0581541e0ca78"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"actix-web",
|
"actix-web",
|
||||||
|
"mutually_exclusive_features",
|
||||||
"pin-project",
|
"pin-project",
|
||||||
"tracing",
|
"tracing",
|
||||||
"uuid",
|
"uuid",
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,7 @@ actix-identity = "0.6.0"
|
||||||
actix-cors = "0.6.4"
|
actix-cors = "0.6.4"
|
||||||
actix-router = "0.5.1"
|
actix-router = "0.5.1"
|
||||||
actix-session = { version = "0.8", features = ["redis-rs-tls-session"] }
|
actix-session = { version = "0.8", features = ["redis-rs-tls-session"] }
|
||||||
openssl = "0.10.45"
|
openssl = { version = "0.10.45" }
|
||||||
|
|
||||||
# serde
|
# serde
|
||||||
serde_json.workspace = true
|
serde_json.workspace = true
|
||||||
|
|
|
||||||
19
README.md
19
README.md
|
|
@ -17,31 +17,40 @@ You'll need to install:
|
||||||
- copy the configurations from `dev.env` to `.env`
|
- copy the configurations from `dev.env` to `.env`
|
||||||
- edit the `.env` as required (such as SMTP configurations)
|
- edit the `.env` as required (such as SMTP configurations)
|
||||||
|
|
||||||
### Run the dependency servers
|
### Run with all dependencies
|
||||||
|
```bash
|
||||||
|
./build/run_local_server.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
This process will execute all the dependencies and start the AppFlowy-Cloud server. Alternatively,
|
||||||
|
you have the option to run the AppFlowy-Cloud server independently### Run the AppFlowy-Cloud
|
||||||
|
|
||||||
|
1. Run the dependency servers
|
||||||
```bash
|
```bash
|
||||||
docker compose --file docker-compose-dev.yml up -d
|
docker compose --file docker-compose-dev.yml up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
### Install sqlx-cli
|
2. Install sqlx-cli
|
||||||
```bash
|
```bash
|
||||||
cargo install sqlx-cli
|
cargo install sqlx-cli
|
||||||
```
|
```
|
||||||
|
|
||||||
### Run sqlx migration
|
3. Run sqlx migration
|
||||||
```bash
|
```bash
|
||||||
sqlx database create
|
sqlx database create
|
||||||
sqlx migrate run
|
sqlx migrate run
|
||||||
cargo sqlx prepare --workspace
|
cargo sqlx prepare --workspace
|
||||||
```
|
```
|
||||||
|
|
||||||
### Run the AppFlowy-Cloud server
|
4. Run the server
|
||||||
```bash
|
```bash
|
||||||
cargo run
|
cargo run
|
||||||
```
|
```
|
||||||
|
|
||||||
### Run the tests
|
### Run the tests
|
||||||
|
|
||||||
#### Test
|
After the server is running, you can run the tests with:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cargo test
|
cargo test
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue