|
@@ -1,6 +1,6 @@
|
|
<h1 align="center" style="margin:0"> AppFlowy_Flutter</h1>
|
|
<h1 align="center" style="margin:0"> AppFlowy_Flutter</h1>
|
|
<div align="center">
|
|
<div align="center">
|
|
- <img src="https://img.shields.io/badge/Flutter-v3.3.10-blue"/>
|
|
|
|
|
|
+ <img src="https://img.shields.io/badge/Flutter-v3.7.5-blue"/>
|
|
<img src="https://img.shields.io/badge/Rust-v1.65-orange"/>
|
|
<img src="https://img.shields.io/badge/Rust-v1.65-orange"/>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
@@ -9,13 +9,16 @@
|
|
This Repository contains the codebase for the frontend of the application, currently we use Flutter as our frontend framework.
|
|
This Repository contains the codebase for the frontend of the application, currently we use Flutter as our frontend framework.
|
|
|
|
|
|
### Platforms Supported Using Flutter 💻
|
|
### Platforms Supported Using Flutter 💻
|
|
|
|
+
|
|
- Linux
|
|
- Linux
|
|
- macOS
|
|
- macOS
|
|
- Windows
|
|
- Windows
|
|
-> We later expect to extend support to Android and iOS devices using Flutter.
|
|
|
|
|
|
+ > We later expect to extend support to Android and iOS devices using Flutter.
|
|
|
|
|
|
### Am I Eligible to Contribute?
|
|
### 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). Some of the ways in which you can contribute are:
|
|
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). Some of the ways in which you can contribute are:
|
|
|
|
+
|
|
- Non-Coding Contributions
|
|
- Non-Coding Contributions
|
|
- Documentation
|
|
- Documentation
|
|
- Feature Requests and Feedbacks
|
|
- Feature Requests and Feedbacks
|
|
@@ -23,26 +26,27 @@ Yes! You are eligible to contribute, check out the ways in which you can [contri
|
|
- Improve Translations
|
|
- Improve Translations
|
|
- Coding Contributions
|
|
- Coding Contributions
|
|
|
|
|
|
-
|
|
|
|
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).
|
|
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).
|
|
|
|
|
|
### What OS Should I Use for Development?
|
|
### 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.
|
|
|
|
|
|
|
|
|
|
+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.
|
|
|
|
|
|
### Getting Started ❇
|
|
### 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.
|
|
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)
|
|
- [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)
|
|
- [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)
|
|
- [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)
|
|
- [How to run/debug the application](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/launcher-and-tasks)
|
|
|
|
|
|
-
|
|
|
|
### Need Help?
|
|
### 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
|
|
- 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!
|
|
- Stuck Somewhere? Join the [Discord](https://discord.gg/9Q2xaN37tV) Group and we are there to help you!
|
|
|
|
|
|
-<!--
|
|
|
|
|
|
+<!--
|
|
## release check
|
|
## release check
|
|
1. [entitlements](https://flutter.dev/desktop#setting-up-entitlements)
|
|
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) -->
|