chk
/
AppFlowy-Cloud
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
430 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 ee3abdb27a
chore: error for oauth (#268) 
* chore: error for oauth

* chore: fmt

* chore: fmt

* chore: add error type

* chore: fix ci
 		2024-01-22 23:43:04 +08:00
.github chore: client api wasm (#262) 2024-01-17 03:20:24 +08:00
.sqlx feat: revamp storage api (#251) 2024-01-11 00:32:11 +08:00
admin_frontend fix: admin frontend libssl 2024-01-19 11:24:43 +08:00
assets docs: added missing image for list sso 2023-11-28 14:23:45 +08:00
build docs: Doc improvement (#256) 2024-01-12 16:01:16 +08:00
cert fix: request fail caused by certificate issue 2023-03-15 09:32:23 +08:00
doc Fix typo in DEPLOYMENT.md 2024-01-15 23:05:29 +01:00
docker feat: gotrue build arch agnostic 2023-12-16 20:25:59 -08:00
libs chore: error for oauth (#268) 2024-01-22 23:43:04 +08:00
migrations fix: use foreign key cascade delete for user cleanup (#188) 2023-12-04 11:52:42 +08:00
nginx fix: optional services 2024-01-15 21:44:07 +08:00
src fix: result return from put blob 2024-01-13 00:53:41 +08:00
tests chore: error for oauth (#268) 2024-01-22 23:43:04 +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 chore: error for oauth (#268) 2024-01-22 23:43:04 +08:00
Cargo.toml feat: revamp storage api (#251) 2024-01-11 00:32:11 +08:00
Dockerfile docs: Doc improvement (#256) 2024-01-12 16:01:16 +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: Doc improvement (#256) 2024-01-12 16:01:16 +08:00
deploy.env feat: update deployment docs 2024-01-14 18:46:15 +08:00
dev.env fix: minio url configs 2024-01-12 22:50:25 +08:00
docker-compose-dev.yml docs: Doc improvement (#256) 2024-01-12 16:01:16 +08:00
docker-compose-extras.yml docs: Doc improvement (#256) 2024-01-12 16:01:16 +08:00
docker-compose.yml Update minio root user & pass variable to match DEPLOYMENT.MD 2024-01-17 21:07:58 -05: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=5432
  • Redis

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

    redis-cli -p 6379

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!