-
-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(appflowy_flutter): Update Documentation
- Added basic information so that new contributors can easily get started with contributions.
- Loading branch information
Showing
1 changed file
with
29 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,39 @@ | ||
# appflowy_flutter | ||
<h1 align="center" style="margin:0"> AppFlowy_Flutter</h1> | ||
<div align="center"> | ||
<img src="https://img.shields.io/badge/Flutter-v3.10.0-blue"/> | ||
<img src="https://img.shields.io/badge/Rust-v1.65-orange"/> | ||
</div> | ||
|
||
A new Flutter project. | ||
> Documentation for Contributors | ||
## Getting Started | ||
This Repository contains the codebase for the frontend of the application, currently we use Flutter as our frontend framework. | ||
|
||
This project is a starting point for a Flutter application. | ||
### Platforms Supported Using Flutter 💻 | ||
- Linux | ||
- macOS | ||
- Windows | ||
> We later expect to extend support to Android and iOS devices using Flutter. | ||
A few resources to get you started if this is your first Flutter project: | ||
### Am I Eligible to Contribute? | ||
Yes! You are eligible to contribute, check out the ways in which you can [contribute to AppFlowy](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/contributing-to-appflowy). However to contribute to `AppFlowy_Flutter` codebase specifically (coding contribution) we suggest you to have basic knowledge of Flutter. In case you are new to Flutter, we may suggest you to learn the basics and then try to contribute, get started with Flutter [here](https://flutter.dev/docs/get-started/codelab). | ||
|
||
- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab) | ||
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook) | ||
### What OS Should I Use for Development? | ||
We support all OS for Development i.e Linux, macOS and Windows. However, most of us promote macOS and Linux over Windows. We have detailed [docs](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/environment-setup) on How to Setup `AppFlowy_Flutter` in your local system in each OS. | ||
|
||
For help getting started with Flutter, view our | ||
[online documentation](https://flutter.dev/docs), which offers tutorials, | ||
samples, guidance on mobile development, and a full API reference. | ||
|
||
### Getting Started ❇ | ||
We have a detailed documentation, on how to [get started](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/contributing-to-appflowy) with the project, and make your first contribution. However, we do have some specific picks for you. | ||
- [Code Architecture](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/architecture/frontend/frontend/codemap) | ||
- [Making Your First PR](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/submitting-code/submitting-your-first-pull-request) | ||
- [The Style Guide](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/submitting-code/style-guides) | ||
- [How to run/debug the application](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/launcher-and-tasks) | ||
|
||
|
||
### Need Help? | ||
- New to GitHub? Follow [these](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/submitting-code/setting-up-your-repositories) steps to get started | ||
- Stuck Somewhere? Join the [Discord](https://discord.gg/9Q2xaN37tV) Group and we are there to help you! | ||
|
||
<!-- | ||
## release check | ||
1. [entitlements](https://flutter.dev/desktop#setting-up-entitlements) | ||
2. [symbols stripped](https://flutter.dev/docs/development/platform-integration/c-interop) | ||
2. [symbols stripped](https://flutter.dev/docs/development/platform-integration/c-interop) --> |