{"id":19614628,"url":"https://github.com/appflowy-io/appflowy-cloud","last_synced_at":"2025-05-14T10:11:25.898Z","repository":{"id":46415291,"uuid":"377498937","full_name":"AppFlowy-IO/AppFlowy-Cloud","owner":"AppFlowy-IO","description":"Bring projects, wikis, and teams together with AI. AppFlowy is the AI collaborative workspace where you achieve more without losing control of your data. The leading open source Notion alternative.","archived":false,"fork":false,"pushed_at":"2025-04-12T14:22:19.000Z","size":17032,"stargazers_count":1406,"open_issues_count":73,"forks_count":339,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-04-13T01:59:35.143Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://appflowy.com","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AppFlowy-IO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"appflowy"}},"created_at":"2021-06-16T13:04:53.000Z","updated_at":"2025-04-12T14:22:21.000Z","dependencies_parsed_at":"2023-10-11T13:41:30.658Z","dependency_job_id":"82a25379-5ad5-4953-98cc-4fd888886512","html_url":"https://github.com/AppFlowy-IO/AppFlowy-Cloud","commit_stats":null,"previous_names":["appflowy-io/appflowy-server"],"tags_count":386,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2FAppFlowy-Cloud","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2FAppFlowy-Cloud/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2FAppFlowy-Cloud/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2FAppFlowy-Cloud/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AppFlowy-IO","download_url":"https://codeload.github.com/AppFlowy-IO/AppFlowy-Cloud/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248654046,"owners_count":21140235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T10:53:09.543Z","updated_at":"2025-04-13T01:59:52.944Z","avatar_url":"https://github.com/AppFlowy-IO.png","language":"Rust","funding_links":["https://ko-fi.com/appflowy"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cpicture\u003e\n        \u003csource srcset=\"assets/logos/appflowy_logo_white.svg\" media=\"(prefers-color-scheme: dark)\"/\u003e\n        \u003cimg src=\"assets/logos/appflowy_logo_black.svg\"  width=\"500\" height=\"200\" /\u003e\n    \u003c/picture\u003e\n\u003c/p\u003e\n\n\u003ch4 align=\"center\"\u003e\n    \u003ca href=\"https://discord.gg/9Q2xaN37tV\"\u003e\u003cimg src=\"https://img.shields.io/badge/AppFlowy.IO-discord-orange\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://opensource.org/licenses/AGPL-3.0\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-AGPL-purple.svg\" alt=\"License: AGPL\"\u003e\u003c/a\u003e\n\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://www.appflowy.com\"\u003e\u003cb\u003eWebsite\u003c/b\u003e\u003c/a\u003e •\n    \u003ca href=\"https://twitter.com/appflowy\"\u003e\u003cb\u003eTwitter\u003c/b\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e⚡ The AppFlowy Cloud written with Rust 🦀\u003c/p\u003e\n\n# AppFlowy Cloud\n\nAppFlowy Cloud is part of the AppFlowy ecosystem, offering secure user authentication, file storage,\nand real-time WebSocket communication for an efficient and collaborative user experience.\n\n## Table of Contents\n\n- [🚀 Deployment](#-deployment)\n- [💻 Development](#-development)\n- [🐞 Debugging](#-debugging)\n- [⚙️ Contributing](#-contributing)\n\n## 🚀 Deployment\n\n- See [deployment guide](./doc/DEPLOYMENT.md)\n\n## 💻 Development\n\n### Pre-requisites\n\nYou'll need to install:\n\n- [Rust](https://www.rust-lang.org/tools/install)\n- [Docker](https://docs.docker.com/get-docker/)\n\n### Configuration\n\n- copy the configurations from `dev.env` to `.env`\n- edit the `.env` as required (such as SMTP configurations)\n\n### Run with all dependencies\n\n```bash\n./script/run_local_server.sh\n```\n\nThis process will execute all the dependencies and start the AppFlowy-Cloud server. Alternatively,\nyou have the option to run the AppFlowy-Cloud server independently\n\n### Run the AppFlowy-Cloud\n\n1. Run the dependency servers\n\n```bash\ndocker compose --file docker-compose-dev.yml up -d\n```\n\n2. Install sqlx-cli\n\n```bash\ncargo install sqlx-cli\n```\n\n3. Run sqlx migration\n\n```bash\nsqlx database create\nsqlx migrate run\ncargo sqlx prepare --workspace\n```\n\n4. Run the server\n\n```bash\ncargo run\n```\n\n### Run the tests\n\nAfter the server is running, you can run the tests with:\n\n```bash\ncargo test\n```\n\n## 🐞Debugging\n\nEffective debugging is essential for maintaining a healthy application. Here are some tools and commands to help you\ntroubleshoot issues in various components of the AppFlowy cloud server:\n\n### Postgres\n\nA web-based administration tool for PostgreSQL. Access it at [PgAdmin](http://localhost:5400)\n\n- OR command line:\n\n```bash\n    export PGPASSWORD=password\n    psql --host=localhost --username=postgres --port=5432\n```\n\n- Redis\n\nRedis offers a powerful command line interface for managing your Redis instance. Connect using the following command:\n\n```bash\n    redis-cli -p 6379\n```\n\n### Minio\n\nMinio provides a Web UI for easy management of your files and buckets. Access it at [Web UI](http://localhost:9001)\n\n### Portainer\n\nFor managing Docker containers, Portainer's Web UI is an excellent tool. Access it at Web UI to easily manage Docker\nenvironments, including container deployment, networking, volume management, and more. Access it\nat [Web UI](http://localhost:9442)\n\n## ⚙️ Contributing\n\nAny new contribution is more than welcome in this project!\nIf you want to know more about the development workflow or want to contribute, please visit\nour [contributing guidelines](./doc/CONTRIBUTING.md) for detailed instructions!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappflowy-io%2Fappflowy-cloud","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappflowy-io%2Fappflowy-cloud","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappflowy-io%2Fappflowy-cloud/lists"}