AppFlowy

(β˜… 75,808)

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.

File Explorer

Download Latest Version (.zip)

Showing a partial file list β€” download the zip above to see everything.

  • .dockerignore
  • .gitignore
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • codemagic.yaml
  • commitlint.config.js
  • LICENSE
  • README.md
  • ROADMAP.md

# Installation Guide

1. Get the code
git clone https://github.com/AppFlowy-IO/AppFlowy

Downloads the entire project code from GitHub to your computer.

cd AppFlowy

Moves into the project folder you just downloaded.

2. CMake

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd frontend/appflowy_flutter/android/app/src/main

This project's files live in a subfolder, so move into it first.

mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

3. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd frontend/appflowy_flutter/android/app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd frontend/appflowy_flutter

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Today's picks

taste-skill β˜… 78,877

Taste-Skill - gives your AI good taste. stops the AI from generating boring, generic slop

JavaScript
flutter β˜… 178,564

Flutter makes it easy and fast to build beautiful apps for mobile and beyond

Dart
hermes-agent β˜… 233,851

The agent that grows with you

Python
llama.cpp β˜… 124,999

LLM inference in C/C++

C++
material-ui β˜… 98,885

Material UI: Comprehensive React component library that implements Google's Material Desig

JavaScript
awesome-interview-questions β˜… 84,141

:octocat: A curated awesome list of lists of interview questions. Feel free to contribute!
// repository documentation