LogoLogo
  • AppFlowy
    • โญStart here
      • Welcome to AppFlowy Docs
      • How to get help
      • Install AppFlowy
    • ๐Ÿ› ๏ธInstallation
      • ๐Ÿ–ฅ๏ธSystem Requirements
      • ๐Ÿ’ฟInstallation methods
        • Mac / Windows / Linux Packages
          • Installing on Linux
            • Installing & Setting up Flutter on Linux from Source
        • Docker
    • ๐ŸŒฑCommunity
      • ๐Ÿค™Get in contact
      • ๐Ÿ“”AppFlowy Mentorship Program
        • Program Guidance
        • Proposal Template
        • Pull Request Template
        • Mentorship 2023
          • Mentee Projects
            • Calendar View for AppFlowy Database
            • Custom Themes
            • Shortcuts and Customized Hotkeys for AppFlowy
            • Table
            • โญFavorites
            • Code Block
            • Outlines
            • Importers
            • AI Writers
            • Templates
          • Project Ideas
      • โœ๏ธWrite for AppFlowy
        • ๐Ÿ“ƒDrafts
          • [Draft] Use Case: Software Engineer
          • [Draft] Use Case: High School Students
          • [Draft] How to add a new property to appflowy database
      • ๐Ÿ‚Hacktoberfest
    • ๐Ÿ›ฃ๏ธRoadmap
    • ๐ŸŒ‹Product
      • ๐Ÿ’ฝData Storage
      • ๐ŸŽจCustomize and Style Content
      • โฎ๏ธDuplicate, Delete, and Restore
      • ๐Ÿ’ŽDatabases
        • ๐Ÿ”ขDatabase Properties
        • ๐Ÿ—ƒ๏ธManage Properties
      • โ“‚๏ธMarkdown
      • โŒจ๏ธShortcuts
      • ๐Ÿช„AppFlowy AI
      • ๐Ÿฆ™AppFlowy Local AI - Ollama
      • ๐ŸŽจThemes
      • โ˜๏ธAppFlowy Cloud
      • ๐ŸงฉAppFlowy Plugins
        • Table-view Databases
        • Kanban Board
        • Calendar
        • Auto Generator
        • Smart Edit
        • Code Blocks
        • Math Equations
        • Cover
        • Emoji
  • Documentation
    • ๐Ÿ’ŽSoftware Contributions
      • ๐ŸŸขGet started
      • ๐Ÿ’€Architecture
        • Frontend
          • Tauri
            • ๐Ÿ—บ๏ธCodeMap
          • Web
            • ๐ŸŒŸDesign Philosophy
          • Flutter
            • ๐Ÿ—บ๏ธProject Structure: CodeMap
            • ๐ŸงฎGrid
            • โš™๏ธSetting
          • Inter-Process Communication
          • User
            • User Data
            • Events & Notifications
          • Folder
            • Events & Notifications
          • Document
          • Database View
            • Events & Notifications
            • Grid
            • Calendar
            • Kanban Board
        • Backend
          • Initialize
          • Events
          • Delta(WIP)
          • Profiling
          • Database
        • Domain Driven Design
        • Proposals
      • ๐Ÿ—๏ธConventions
        • ๐Ÿ”คNaming Conventions
        • โŒจ๏ธCode Conventions
          • ๐ŸฆFlutter
        • ๐Ÿ™Git Conventions
      • ๐Ÿ’›Submitting Code
        • ๐ŸฆSetting Up Your Repositories
        • โคด๏ธSubmitting your first Pull Request
      • ๐ŸคŸCoding Standards and Practices
        • ๐Ÿ‘ฝRust Backend
    • ๐Ÿš€AppFlowy
      • ๐Ÿ‘พHow to contribute to AppFlowy
      • ๐Ÿ—๏ธBuilding from Source
        • ๐ŸŒณFlutter Setup
          • ๐ŸงBuilding on Linux
          • ๐ŸŽBuilding on macOS
          • ๐ŸชŸBuilding on Windows
        • ๐ŸŒWeb Setup
        • ๐Ÿ“กTauri Setup
      • โ˜๏ธDebugging with AppFlowy Cloud
      • ๐Ÿ”Debugging in VS Code
      • โ˜Ž๏ธTranslate AppFlowy
      • โ“Troubleshooting
      • ๐Ÿ‘ฎโ€โ™€๏ธLicenses
    • ๐Ÿ๏ธAppFlowy Editor
      • โŒจ๏ธHow to Implement Markdown Syntax To Style Text In AppFlowy Editor
      • ๐ŸงฉHow to Create a Plugin for AppFlowy Editor
      • ๐Ÿ‘ฎโ€โ™€๏ธLicenses
    • โ˜๏ธAppFlowy Cloud
      • ๐ŸŒˆArchitecture
      • โ˜€๏ธDeployment
  • Guides
    • Sync Desktop and Mobile
    • Self-Hosting AppFlowy
      • โ˜๏ธSelf-hosting AppFlowy with AppFlowy Cloud
      • ๐Ÿ†“Self-hosting AppFlowy for free Using Supabase
    • Import From Notion
  • Blog Highlights
    • ๐Ÿ”ฎDemystifying AppFlowy Editor's Codebase
  • Handbook
    • Core values
Powered by GitBook
On this page
  • Environment setup
  • Coding Conventions
  • Architecture documentation
  • How-tos

Was this helpful?

Edit on GitHub
  1. Documentation

AppFlowy

PreviousRust BackendNextHow to contribute to AppFlowy

Last updated 1 year ago

Was this helpful?

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.

Coding Conventions

Architecture documentation

How-tos

๐Ÿš€
๐ŸงBuilding on Linux
๐ŸŽBuilding on macOS
๐ŸชŸBuilding on Windows
๐Ÿ™Git Conventions
โŒจ๏ธCode Conventions
๐Ÿ”คNaming Conventions
๐Ÿ’€Architecture
How we built AppFlowy with Flutter and Rust
How we built a highly customizable rich-text editor for Flutter
โ˜Ž๏ธTranslate AppFlowy
โคด๏ธSubmitting your first Pull Request