README.md

💻 Software Contributions

Welcome to the AppFlowy software development documentation. Here you will find all of the resources that you need to start developing on the AppFlowy project.

These pages will guide you through the stages of setting up your development environment, connecting to our code base, learning how to code for AppFlowy and finally submitting code to the project.

Environment setup

In order to start developing you will need to setup your environment. We have setup instructions for Linux, MacOS, and Windows.

{% content-ref url="environment-setup/building-on-linux.md" %} building-on-linux.md {% endcontent-ref %}

{% content-ref url="environment-setup/building-on-macos.md" %} building-on-macos.md {% endcontent-ref %}

{% content-ref url="environment-setup/building-on-windows.md" %} building-on-windows.md {% endcontent-ref %}

Coding Conventions

{% content-ref url="submitting-code/style-guides.md" %} style-guides.md {% endcontent-ref %}

{% content-ref url="submitting-code/code-submission-guidelines.md" %} code-submission-guidelines.md {% endcontent-ref %}

Architecture documentation

{% content-ref url="../architecture/" %} architecture {% endcontent-ref %}

• How we built AppFlowy with Flutter and Rust

How-tos

{% content-ref url="translation.md" %} translation.md {% endcontent-ref %}

{% content-ref url="submitting-code/submitting-your-first-pull-request.md" %} submitting-your-first-pull-request.md {% endcontent-ref %}