|
| 1 | +<h1 align="center" style="border-bottom: none"> |
| 2 | + <b> |
| 3 | + <a href="https://www.appflowy.com">AppFlowy</a><br> |
| 4 | + </b> |
| 5 | + ⭐️ The Open Source Alternative To Notion ⭐️ <br> |
| 6 | +</h1> |
| 7 | + |
| 8 | +<p align="center"> |
| 9 | +AppFlowy is the AI workspace where you achieve more without losing control of your data |
| 10 | +</p> |
| 11 | + |
| 12 | +<p align="center"> |
| 13 | +<a href="https://discord.gg/9Q2xaN37tV"><img src="https://img.shields.io/badge/AppFlowy.IO-discord-orange"></a> |
| 14 | +<a href="https://github.com/AppFlowy-IO/appflowy"><img src="https://img.shields.io/github/stars/AppFlowy-IO/appflowy.svg?style=flat&logo=github&colorB=deeppink&label=stars"></a> |
| 15 | +<a href="https://github.com/AppFlowy-IO/appflowy"><img src="https://img.shields.io/github/forks/AppFlowy-IO/appflowy.svg"></a> |
| 16 | +<a href="https://opensource.org/licenses/AGPL-3.0"><img src="https://img.shields.io/badge/license-AGPL-purple.svg" alt="License: AGPL"></a> |
| 17 | + |
| 18 | +</p> |
| 19 | + |
| 20 | +<p align="center"> |
| 21 | + <a href="https://www.appflowy.com"><b>Website</b></a> • |
| 22 | + <a href="https://forum.appflowy.io/"><b>Forum</b></a> • |
| 23 | + <a href="https://discord.gg/9Q2xaN37tV"><b>Discord</b></a> • |
| 24 | + <a href="https://www.reddit.com/r/AppFlowy"><b>Reddit</b></a> • |
| 25 | + <a href="https://twitter.com/appflowy"><b>Twitter</b></a> |
| 26 | +</p> |
| 27 | + |
| 28 | +<p align="center"><img src="https://appflowy.com/_next/static/media/tasks.796c753e.png" alt="AppFlowy Kanban Board for To-dos" /></p> |
| 29 | +<p align="center"><img src="https://appflowy.com/_next/static/media/Grid.9e30484b.png" alt="AppFlowy Databases for Tasks and Projects" /></p> |
| 30 | +<p align="center"><img src="https://appflowy.com/_next/static/media/sites.a8d5b2b9.png" alt="AppFlowy Sites for Beautiful documentation" /></p> |
| 31 | +<p align="center"><img src="https://appflowy.com/_next/static/media/ai.e1460982.png" alt="AppFlowy AI" /></p> |
| 32 | +<p align="center"><img src="https://appflowy.com/_next/static/media/template.9ea13c3b.png" alt="AppFlowy Templates" /></p> |
| 33 | + |
| 34 | +<br></br> |
| 35 | +<p align="center" > |
| 36 | + <img src="https://github.com/user-attachments/assets/5841c491-b564-4a26-b9b6-191def430911" alt="Work across devices" width="1040px" /></p> |
| 37 | +<p align="center" > |
| 38 | + <img src="https://github.com/user-attachments/assets/c2ba6bb8-746c-4743-9393-d008a669be95" alt="Work across devices" width="1040px" /></p> |
| 39 | +<p align="center" > |
| 40 | + <img src="https://github.com/user-attachments/assets/e83dd1a3-4975-4d0e-91a1-9eb6e0d248cd" alt="Work across devices" width="1040px" /></p> |
| 41 | + |
| 42 | +## User Installation |
| 43 | + |
| 44 | +- [Download AppFlowy Desktop (macOS, Windows, and Linux)](https://github.com/AppFlowy-IO/AppFlowy/releases) |
| 45 | +- Other |
| 46 | + channels: [FlatHub](https://flathub.org/apps/io.appflowy.AppFlowy), [Snapcraft](https://snapcraft.io/appflowy), [Sourceforge](https://sourceforge.net/projects/appflowy/) |
| 47 | +- Available on |
| 48 | + - [App Store](https://apps.apple.com/app/appflowy/id6457261352): iPhone |
| 49 | + - [Play Store](https://play.google.com/store/apps/details?id=io.appflowy.appflowy): Android 10 or above; ARMv7 is |
| 50 | + not supported |
| 51 | +- [Self-hosting AppFlowy](https://appflowy.com/docs/self-host-appflowy-overview) |
| 52 | +- [Source](https://docs.appflowy.io/docs/documentation/appflowy/from-source) |
| 53 | + |
| 54 | +## Built With |
| 55 | + |
| 56 | +- [Flutter](https://flutter.dev/) |
| 57 | + |
| 58 | +- [Rust](https://www.rust-lang.org/) |
| 59 | + |
| 60 | +## Stay Up-to-Date |
| 61 | + |
| 62 | +<p align="center"><img src="https://github.com/AppFlowy-IO/appflowy/blob/main/doc/imgs/howtostar.gif" alt="AppFlowy Github - how to star the repo" width="100%" /></p> |
| 63 | + |
| 64 | +## Getting Started with development |
| 65 | + |
| 66 | +Please view our comprehensive [build from source guide](doc/BUILD_FROM_SOURCE.md) for detailed OS-specific development instructions, including desktop and mobile platform support. |
| 67 | + |
| 68 | +For additional documentation, visit [docs.appflowy.io](https://docs.appflowy.io/docs/documentation/appflowy/from-source). |
| 69 | + |
| 70 | +## Roadmap |
| 71 | + |
| 72 | +- [AppFlowy Roadmap ReadMe](https://docs.appflowy.io/docs/appflowy/roadmap) |
| 73 | +- [AppFlowy Public Roadmap](https://github.com/orgs/AppFlowy-IO/projects/5/views/12) |
| 74 | + |
| 75 | +If you'd like to propose a feature, submit a feature |
| 76 | +request [here](https://github.com/AppFlowy-IO/AppFlowy/issues/new?assignees=&labels=&template=feature_request.yaml&title=%5BFR%5D+) <br/> |
| 77 | +If you'd like to report a bug, submit a bug |
| 78 | +report [here](https://github.com/AppFlowy-IO/AppFlowy/issues/new?assignees=&labels=&template=bug_report.yaml&title=%5BBug%5D+) |
| 79 | + |
| 80 | +## **Releases** |
| 81 | + |
| 82 | +Please see the [changelog](https://appflowy.com/what-is-new) for more details about a given release. |
| 83 | + |
| 84 | +## Contributing |
| 85 | + |
| 86 | +Contributions make the open-source community a fantastic place to learn, inspire, and create. Any contributions you make |
| 87 | +are **greatly appreciated**. Please look |
| 88 | +at [Contributing to AppFlowy](https://docs.appflowy.io/docs/documentation/software-contributions/contributing-to-appflowy) |
| 89 | +for details. |
| 90 | + |
| 91 | +If your Pull Request is accepted as it fixes a bug, adds functionality, or makes AppFlowy's codebase significantly |
| 92 | +easier to use or understand, **Congratulations!** If your administrative and managerial work behind the scenes sustains |
| 93 | +the community, **Congratulations!** You are now an official contributor to AppFlowy. |
| 94 | + |
| 95 | +## Translations 🌎🗺 |
| 96 | + |
| 97 | +[](https://inlang.com/editor/github.com/AppFlowy-IO/AppFlowy?ref=badge) |
| 98 | + |
| 99 | +To add translations, you can manually edit the JSON translation files in `/frontend/resources/translations`, use |
| 100 | +the [inlang online editor](https://inlang.com/editor/github.com/AppFlowy-IO/AppFlowy), or |
| 101 | +run `npx inlang machine translate` to add missing translations. |
| 102 | + |
| 103 | +## Join the community to build AppFlowy together |
| 104 | + |
| 105 | +<a href="https://github.com/AppFlowy-IO/AppFlowy/graphs/contributors"> |
| 106 | + <img src="https://contrib.rocks/image?repo=AppFlowy-IO/AppFlowy" /> |
| 107 | +</a> |
| 108 | + |
| 109 | +## Why Are We Building This? |
| 110 | + |
| 111 | +Notion has been our favourite project and knowledge management tool in recent years because of its aesthetic appeal and |
| 112 | +functionality. Our team uses it daily, and we are on its paid plan. However, as we all know, Notion has its limitations. |
| 113 | +These include weak data security and poor compatibility with mobile devices. Likewise, alternative collaborative |
| 114 | +workplace management tools also have their constraints. |
| 115 | + |
| 116 | +The limitations we encountered using these tools and our past work experience with collaborative productivity tools have |
| 117 | +led to our firm belief that there is a glass ceiling on what's possible for these tools in the future. This emanates |
| 118 | +from the fact that these tools will probably struggle to scale horizontally at some point and be forced to prioritize a |
| 119 | +proportion of customers whose needs differ from the rest. While decision-makers want a workplace OS, it is impossible to |
| 120 | +come up with a one-size fits all solution in such a fragmented market. |
| 121 | + |
| 122 | +When a customer's evolving core needs are not satisfied, they either switch to another or build one from the ground up, |
| 123 | +in-house. Consequently, they either go under another ceiling or buy an expensive ticket to learn a hard lesson. This is |
| 124 | +a requirement for many resources and expertise, building a reliable and easy-to-use collaborative tool, not to mention |
| 125 | +the speed and native experience. The same may apply to individual users as well. |
| 126 | + |
| 127 | +All these restrictions necessitate our mission - to make it possible for anyone to create apps that suit their needs |
| 128 | +well. |
| 129 | + |
| 130 | +- To individuals, we would like to offer Notion's functionality, data security, and cross-platform native experience. |
| 131 | +- To enterprises and hackers, AppFlowy is dedicated to offering building blocks and collaboration infra services to |
| 132 | + enable you to make apps on your own. Moreover, you have 100% control of your data. You can design and modify AppFlowy |
| 133 | + your way, with a single codebase written in Flutter and Rust supporting multiple platforms armed with long-term |
| 134 | + maintainability. |
| 135 | + |
| 136 | +We decided to achieve this mission by upholding the three most fundamental values: |
| 137 | + |
| 138 | +- Data privacy first |
| 139 | +- Reliable native experience |
| 140 | +- Community-driven extensibility |
| 141 | + |
| 142 | +We do not claim to outperform Notion in terms of functionality and design, at least for now. Besides, our priority |
| 143 | +doesn't lie in more functionality at the moment. Instead, we would like to cultivate a community to democratize the |
| 144 | +knowledge and wheels of making complex workplace management tools while enabling people and businesses to create |
| 145 | +beautiful things on their own by equipping them with a versatile toolbox of building blocks. |
| 146 | + |
| 147 | +## License |
| 148 | + |
| 149 | +Distributed under the AGPLv3 License. See [`LICENSE.md`](https://github.com/AppFlowy-IO/AppFlowy/blob/main/LICENSE) for |
| 150 | +more information. |
| 151 | + |
| 152 | +## Acknowledgments |
| 153 | + |
| 154 | +Special thanks to these amazing projects which help power AppFlowy: |
| 155 | + |
| 156 | +- [cargo-make](https://github.com/sagiegurari/cargo-make) |
| 157 | +- [contrib.rocks](https://contrib.rocks) |
| 158 | +- [flutter_chat_ui](https://pub.dev/packages/flutter_chat_ui) |
0 commit comments