68 lines
1.1 KiB
Markdown
68 lines
1.1 KiB
Markdown
# AppFlowy Cloud
|
|
- Cloud Server for AppFlowy
|
|
|
|
## Deployment
|
|
- See [deployment guide](./doc/deployment.md)
|
|
|
|
## Development
|
|
|
|
### Pre-requisites
|
|
|
|
You'll need to install:
|
|
|
|
- [Rust](https://www.rust-lang.org/tools/install)
|
|
- [Docker](https://docs.docker.com/get-docker/)
|
|
|
|
### Configuration
|
|
- copy the configurations from `dev.env` to `.env`
|
|
- edit the `.env` as required (such as SMTP configurations)
|
|
|
|
### Run the dependency servers
|
|
```bash
|
|
docker compose --file docker-compose-dev.yml up -d
|
|
```
|
|
|
|
### Install sqlx-cli
|
|
```bash
|
|
cargo install sqlx-cli
|
|
```
|
|
|
|
### Run sqlx migration
|
|
```bash
|
|
sqlx database create
|
|
sqlx migrate run
|
|
cargo sqlx prepare --workspace
|
|
```
|
|
|
|
### Run the AppFlowy-Cloud server
|
|
```bash
|
|
cargo run
|
|
```
|
|
|
|
### Run the tests
|
|
|
|
#### Test
|
|
```bash
|
|
cargo test
|
|
```
|
|
|
|
### Debugging
|
|
#### Postgres
|
|
- [PgAdmin](http://localhost:5400)
|
|
- OR command line:
|
|
```bash
|
|
export PGPASSWORD=password
|
|
psql --host=localhost --username=postgres --port=5433
|
|
```
|
|
|
|
- Redis
|
|
```bash
|
|
redis-cli -p 6380
|
|
```
|
|
|
|
#### Minio
|
|
- [Web UI](http://localhost:9001)
|
|
|
|
#### Portainer
|
|
- [Web UI](http://localhost:9442)
|