Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.51 KB

README.md

File metadata and controls

54 lines (37 loc) · 2.51 KB

🚀 AppFlowy

Welcome to the AppFlowy software development documentation. Here you will find all of the resources that you need to start developing 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 set up your environment. We have set up instructions for Linux, MacOS, and Windows.

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

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

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

Coding Conventions

{% content-ref url="../software-contributions/conventions/git-conventions.md" %} git-conventions.md {% endcontent-ref %}

{% content-ref url="../software-contributions/conventions/code-conventions/" %} code-conventions {% endcontent-ref %}

{% content-ref url="../software-contributions/conventions/naming-conventions.md" %} naming-conventions.md {% endcontent-ref %}

Architecture documentation

{% content-ref url="../../essential-documentation/contribute-to-appflowy/architecture/" %} architecture {% endcontent-ref %}

How-tos

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

{% content-ref url="../../essential-documentation/contribute-to-appflowy/software-contributions/submitting-code/submitting-your-first-pull-request.md" %} submitting-your-first-pull-request.md {% endcontent-ref %}