chk
/
AppFlowy-Cloud
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
394 Commits 2 Branches 0 Tags 17 MiB
Rust 91.1%
HTML 6.9%
PLpgSQL 0.9%
Shell 0.4%
CSS 0.3%
Other 0.4%
Go to file
Nathan.fooo 2159c68688
chore: add client api version (#248) 
* chore: add client api version

* chore: update

* chore: update

* chore: log client version
 		2024-01-05 09:06:08 +08:00
.github refactor: remove rust-s3, sqlx from client-api (#245) 2024-01-05 06:12:01 +08:00
.sqlx feat: create snapshot for collab (#221) 2023-12-17 13:38:55 +08:00
admin_frontend chore: update build admin_frontend context 2023-12-18 03:50:42 +08:00
assets docs: added missing image for list sso 2023-11-28 14:23:45 +08:00
build refactor: remove rust-s3, sqlx from client-api (#245) 2024-01-05 06:12:01 +08:00
cert fix: request fail caused by certificate issue 2023-03-15 09:32:23 +08:00
configuration feat: casbin access control (#178) 2023-12-11 11:08:15 +08:00
doc docs: improve info on external postgres 2023-12-28 11:35:38 +08:00
docker feat: gotrue build arch agnostic 2023-12-16 20:25:59 -08:00
libs chore: add client api version (#248) 2024-01-05 09:06:08 +08:00
migrations fix: use foreign key cascade delete for user cleanup (#188) 2023-12-04 11:52:42 +08:00
nginx feat: encode batch create collab data as binary (#242) 2024-01-03 06:07:21 +08:00
src chore: add client api version (#248) 2024-01-05 09:06:08 +08:00
tests refactor: remove rust-s3, sqlx from client-api (#245) 2024-01-05 06:12:01 +08:00
.dockerignore feat: use apply server migration when server starts (#30) 2023-09-12 15:12:08 +08:00
.gitignore Test deploy docker log (#105) 2023-10-08 21:42:25 +08:00
Cargo.lock refactor: remove rust-s3, sqlx from client-api (#245) 2024-01-05 06:12:01 +08:00
Cargo.toml chore: bump collab (#244) 2024-01-03 09:39:34 +08:00
Dockerfile feat: use only env var for appflowy cloud (#224) 2023-12-19 08:45:42 +08:00
LICENSE chore: add license 2023-07-28 21:05:27 +08:00
Makefile chore: remove redundant sqlx command (#22) 2023-09-08 22:51:16 +08:00
README.md docs: fix carriage return in readme 2023-12-07 16:48:07 +01:00
deploy.env S3 compatiblity with garage 2023-12-28 15:54:23 +01:00
dev.env S3 compatiblity with garage 2023-12-28 15:54:23 +01:00
docker-compose-dev.yml feat: try to resotre from snapshot when fail to initialize the collab in CollabStoragePlugin (#222) 2023-12-18 02:27:49 +08:00
docker-compose.yml feat: add gotrue image to docker compose 2023-12-27 05:46:34 +08:00
rustfmt.toml feat: ws connect (#3) 2023-05-08 19:03:50 +08:00

README.md

License: AGPL

Website • Twitter

⚡ The AppFlowy Cloud written with Rust 🦀

AppFlowy Cloud

AppFlowy Cloud is part of the AppFlowy ecosystem, offering secure user authentication, file storage, and real-time WebSocket communication for an efficient and collaborative user experience.

Table of Contents

🚀 Deployment

💻 Development

Pre-requisites

You'll need to install:

Configuration

  • copy the configurations from dev.env to .env
  • edit the .env as required (such as SMTP configurations)

Run with all dependencies

./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
docker compose --file docker-compose-dev.yml up -d
  1. Install sqlx-cli
cargo install sqlx-cli
  1. Run sqlx migration
sqlx database create
sqlx migrate run
cargo sqlx prepare --workspace
  1. Run the server
cargo run

Run the tests

After the server is running, you can run the tests with:

cargo test

🐞Debugging

Effective debugging is essential for maintaining a healthy application. Here are some tools and commands to help you troubleshoot issues in various components of the AppFlowy cloud server:

Postgres

A web-based administration tool for PostgreSQL. Access it at PgAdmin

  • OR command line:
    export PGPASSWORD=password
    psql --host=localhost --username=postgres --port=5433
  • Redis

Redis offers a powerful command line interface for managing your Redis instance. Connect using the following command:

    redis-cli -p 6380

Minio

Minio provides a Web UI for easy management of your files and buckets. Access it at Web UI

Portainer

For managing Docker containers, Portainer's Web UI is an excellent tool. Access it at Web UI to easily manage Docker environments, including container deployment, networking, volume management, and more. Access it at Web UI

⚙️ Contributing

Any new contribution is more than welcome in this project! If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions!