Mirrored_Repos/AppFlowy
1
0
Fork 0
mirror of https://github.com/AppFlowy-IO/AppFlowy.git synced 2024-08-30 18:12:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
562 Commits 28 Branches 84 Tags 109 MiB
Dart 54.7%
Rust 26.2%
TypeScript 15.9%
C++ 0.9%
CMake 0.5%
Other 1.5%
45bb157aa7
Go to file
appflowy 45bb157aa7 [rust]: remove the latest view marker after deleting the view
2021-11-11 14:11:45 +08:00
.githooks config precommit hook 2021-07-08 14:14:03 +08:00
.github Update issue templates 2021-10-31 22:43:55 +08:00
.run save user info to pg && response to client with protobuf data 2021-08-22 15:32:48 +08:00
app_flowy [flutter]: fix bugs 2021-11-11 14:04:41 +08:00
backend [flutter]: open latest view after launch 2021-11-10 23:40:13 +08:00
delta_markdown@3e121c546f [flutter]: export mark down & migrate to flutter_bloc 7.0 interface 2021-11-10 18:27:01 +08:00
doc Add files via upload 2021-11-10 16:42:38 +08:00
rust-lib [rust]: remove the latest view marker after deleting the view 2021-11-11 14:11:45 +08:00
scripts [rust]: fix multi thread test bugs 2021-11-09 17:50:32 +08:00
.dockerignore config server docker 2021-08-21 23:19:57 +08:00
.gitignore [flutter]: add some scripts 2021-11-07 10:34:28 +08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2021-10-28 11:37:19 +08:00
LICENSE Create License 2021-11-09 10:26:37 +08:00
Makefile [flutter]: update flowy_env script 2021-11-06 23:27:30 +08:00
Makefile.toml [rust]: create default workspace 2021-11-08 19:19:02 +08:00
README.md Update README.md v0.3 2021-11-10 17:13:54 +08:00

README.md

AppFlowy.IO
 ⭐️ The Open Source Notion Alternative ⭐️

You are in charge of your data and customizations.

GitHub stars

Website • Discord • Twitter •

The Open Source Notion Alternative.

Built With

Stay Up-to-Date

GIF (how to star)

Getting Started

To get a local copy up and running, please follow these simple steps.

Development environment setup:

Step 1:

Step 2:

  • cd appflowy
  • make install_rust

skip if you already installed it

  • make nstall_cargo_make

AppFlowy uses https://github.com/sagiegurari/cargo-make to construct the build scripts

  • cargo make flowy_dev

It's located at xxx/appflowy/scripts/makefile/env.toml. flowy_dev consists of three tasks:

  • install_targets
  • install_diesel
  • install_protobuf

Step 3:

  • Follow the instructions here to install Flutter. As AppFlowy uses the dev channel, you need to switch the channel. Just type:

flutter channel dev

Step 4:

  • Open the app_flowy folder located at xx/appflowy/app_flowy with Visual Studio or other IDEs at your disposal
  • Go to the Run and Debug tab and then click the run button. Run the project

Roadmap

AppFlowy Roadmap

If you'd like to propose a feature, submit an issue here

Releases

Please see the changelog for more details about a given release.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. Please look at CONTRIBUTING.md for details.

Why Are We Building This?

Notion has been our favorite project and knowledge management tool in recent years because of its aesthetic appeal and functionality. Our team uses it daily, and we are on its paid plan. However, as we all know Notion has its limitations. These include weak data security and poor compatibility with mobile devices. Likewise, alternative collaborative workplace management tools also have their constraints.

The limitations we encountered using these tools rooted in our past work experience with collaborative productivity tools lead to our firm belief that there is, and will be a glass ceiling on what's possible in the future for tools like Notion. This emanates from these tools probable struggles to scale horizontally at some point. It implies that they will likely be forced to prioritize for a proportion of customers whose needs can be quite different from the rest. While decision-makers want a workplace OS, the truth is that it is not very possible to come up with a one-size fits all solution in such a fragmented market.

When a customer's evolving core needs are not satisfied, they either switch to another or build one from the ground up, in-house. Consequently, they either go under another ceiling or buy an expensive ticket to learn a hard lesson. This is a requirement for many resources and expertise, building a reliable and easy-to-use collaborative tool, not to mention the speed and native experience. The same may apply to individual users as well.

All these restrictions necessitate our mission - to make it possible for anyone to create apps that suit their needs well.

  • To individuals, we would like to offer Notion's functionality along with data security and cross-platform native experience.
  • To enterprises and hackers, AppFlowy is dedicated to offering building blocks, that is, collaboration infra services to enable you to make apps on your own. Moreover, you have 100% control of your data. You can design and modify AppFlowy your way, with a single codebase written in Flutter and Rust supporting multiple platforms armed with long-term maintainability.

We decided to achieve this mission by upholding the three most fundamental values:

  • Data privacy first
  • Reliable native experience
  • Community-driven extensibility

To be honest, we do not claim to outperform Notion in terms of functionality and design, at least for now. Besides, our priority doesn't lie in more functionality at the moment. Instead, we would like to cultivate a community to democratize the knowledge and wheels of making complex workplace management tools, while enabling people and businesses to create beautiful things on their own by equipping them with a versatile toolbox of building blocks.

License

Distributed under the AGPLv3 License. See LICENSE.md for more information.

Acknowledgements

Special thanks to these amazing projects which help power AppFlowy.IO: