Mirrored_Repos/AppFlowy
1
0
Fork 0
mirror of https://github.com/AppFlowy-IO/AppFlowy.git synced 2024-08-30 18:12:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'settings-modal' of github.com:Hari-07/appflowy into settings-modal

Browse Source
This commit is contained in:
Harinandan 2022-01-21 10:40:45 +05:30
commit 1c8d5a782b
6 changed files with 94 additions and 182 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

143
README.md
View File

@ -2,9 +2,12 @@
<b>
<a href="https://www.appflowy.io">AppFlowy.IO</a><br>
</b>
⭐️ The Open Source Notion Alternative ⭐️ <br>
⭐️ The Open Source Alternative To Notion ⭐️ <br>
</h1>
<p align="center">
You are in charge of your data and customizations.
</p>
<p align="center">
<a href="https://discord.gg/9Q2xaN37tV"><img src="https://img.shields.io/badge/AppFlowy.IO-discord-orange"></a>
@ -14,73 +17,16 @@
</p>
<p align="center">
You are in charge of your data and customizations.
</p>
<p align="center">
<a href="http://www.appflowy.io"><b>Website</b></a> •
<a href="https://discord.gg/9Q2xaN37tV"><b>Discord</b></a> •
<a href="https://twitter.com/appflowy"><b>Twitter</b></a> •
</p>
<p align="center"><img src="https://github.com/AppFlowy-IO/appflowy/blob/main/doc/imgs/welcome.png" alt="The Open Source Notion Alternative." width="1000px" /></p>
<p align="center"><img src="https://github.com/AppFlowy-IO/appflowy/blob/main/doc/imgs/welcome.png" alt="The Open Source Alternative To Notion." width="1000px" /></p>
## Install
### macOS
```sh
brew install appflowy
```
### Windows
There is currently no Windows installer. However, you can download and install the app from the GitHub Releases section.
1. Go to AppFlowy's [Releases](https://github.com/AppFlowy-IO/appflowy/releases/) page on GitHub.
2. Download the current AppFlowy-Windows.zip file
3. Create a directory in your %userprofile%\documents folder
```shell
md %userprofile%\documents\appflowy
```
4. Change to that directory
```shell
cd %userprofile%\documents\appflowy
```
5. Extract the downloaded zip file into the directory you just created.
6. Run the application :
```shell
./app_flowy.exe
```
### Linux
There is currently no Linux installer. However, you can download and install the app from the GitHub Releases section.
1. Go to AppFlowy's [Releases](https://github.com/AppFlowy-IO/appflowy/releases/) page on GitHub.
2. Download the current AppFlowy-Linux.tar.gz file.
3. Create a directory in your /opt/ folder.
```shell
mkdir /opt/appflowy
```
4. Change to that directory
```shell
cd /opt/appflowy
```
5. Extract the downloaded compressed file into the directory you just created.
```shell
tar -xvf AppFlowy-Linux.tar.gz
```
6. Run the application :
```shell
./app_flowy
```
## User Installation
Please view the [documentation](https://appflowy.gitbook.io/docs/essential-documentation/install-appflowy/installation-methods) for OS specific installation instructions.
## Built With
@ -92,72 +38,8 @@ tar -xvf AppFlowy-Linux.tar.gz
<p align="center"><img src="https://github.com/AppFlowy-IO/appflowy/blob/main/doc/imgs/howtostar.gif" alt="AppFlowy Github" width="1000px" /></p>
## Getting Started
### Linux
Please follow these instructions to build on [Linux](doc/BUILD_ON_LINUX.md).
### Windows
Please follow these instructions to build on [Windows](doc/BUILD_ON_WINDOWS.md).
### macOS
How to build on MacOS, please follow these simple steps.
**Step 1:**
```shell
git clone https://github.com/AppFlowy-IO/appflowy.git
```
**Step 2:**
```shell
cd appflowy/frontend
```
```shell
make install_rust
```
```shell
source $HOME/.cargo/env
```
```shell
make install_cargo_make
```
```shell
cargo make install_targets
```
>
>
> 🚀 Skip install_rust or install_cargo_make if you already installed it.
> FYI, AppFlowy uses [https://github.com/sagiegurari/cargo-make](https://github.com/sagiegurari/cargo-make) to construct the build scripts
**Step 3:**
Follow the instructions [here](https://flutter.dev/docs/get-started/install) to install Flutter. As AppFlowy uses the `stable` channel, you need to switch the channel. Just type:
```shell
flutter channel stable
```
**Step 4:**
* Open the `app_flowy` folder located at xx/appflowy/frontend with Visual Studio Code or other IDEs at your disposal.
* Run the Generate Language Files command if you don't run it before or you have updated the localization files. Read more at [AppFlowy translation](https://github.com/AppFlowy-IO/docs/blob/main/welcome-to-the-appflowy-wiki/translation.md)
![Generate Language Files](https://user-images.githubusercontent.com/86001920/148005536-6b311b85-9335-43be-a908-5be0663be8d2.png)
* Click the run button.
![Run the project](https://user-images.githubusercontent.com/86001920/148005558-425b248a-a5dc-4db9-a260-7b8dc32a9dc2.png)
Please also check the device selection, AppFlowy only supports Desktop by now:
![device](https://user-images.githubusercontent.com/86001920/144546864-cebbf0c0-4eef-424e-93c7-e1e6b3a59669.png)
If you encounter any issues, have a look at [Troubleshooting](https://github.com/AppFlowy-IO/appflowy/wiki/Troubleshooting) first. If your issue is not included in the page, please create an [issue](https://github.com/AppFlowy-IO/appflowy/issues/new/choose) or ask on [Discord](https://discord.gg/9Q2xaN37tV).
## Getting Started with development
Please view the [documentation](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy) for OS specific development instructions
## Roadmap
@ -167,11 +49,11 @@ If you'd like to propose a feature, submit an issue [here](https://github.com/Ap
## **Releases**
Please see the [changelog](https://www.appflowy.io/whatsnew) for more details about a given release.
Please see the [changelog](https://www.appflowy.io/whatsnew) for more details about a given release.
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Please look at [CONTRIBUTING.md](https://github.com/AppFlowy-IO/appflowy/blob/main/doc/CONTRIBUTING.md) for details.
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Please look at [CONTRIBUTING.md](https://github.com/AppFlowy-IO/appflowy/blob/main/doc/CONTRIBUTING.md) for details.
## Why Are We Building This?
@ -196,10 +78,11 @@ To be honest, we do not claim to outperform Notion in terms of functionality and
## License
Distributed under the AGPLv3 License. See `LICENSE.md` for more information.
Distributed under the AGPLv3 License. See `LICENSE.md` for more information.
## Acknowledgements
Special thanks to these amazing projects which help power AppFlowy.IO:
- [flutter-quill](https://github.com/singerdmx/flutter-quill)
- [cargo-make](https://github.com/sagiegurari/cargo-make)

3
frontend/app_flowy/.gitignore vendored
View File

@ -58,4 +58,5 @@ windows/flutter/dart_ffi/
**/**/*.a
**/**/*.lib
**/**/*.dll
**/**/*.so
**/**/*.so
**/Brewfile.lock.json

2
frontend/app_flowy/lib/user/infrastructure/network_monitor.dart
View File

@ -41,6 +41,8 @@ class NetworkMonitor {
return NetworkType.Cell;
case ConnectivityResult.none:
return NetworkType.UnknownNetworkType;
case ConnectivityResult.bluetooth:
return NetworkType.UnknownNetworkType;
}
}();
Log.info("Network type: $networkType");

106
frontend/app_flowy/pubspec.lock
View File

@ -7,14 +7,14 @@ packages:
name: _fe_analyzer_shared
url: "https://pub.dartlang.org"
source: hosted
version: "30.0.0"
version: "31.0.0"
analyzer:
dependency: transitive
description:
name: analyzer
url: "https://pub.dartlang.org"
source: hosted
version: "2.7.0"
version: "2.8.0"
animations:
dependency: transitive
description:
@ -56,7 +56,7 @@ packages:
name: build
url: "https://pub.dartlang.org"
source: hosted
version: "2.1.1"
version: "2.2.1"
build_config:
dependency: transitive
description:
@ -77,21 +77,21 @@ packages:
name: build_resolvers
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.5"
version: "2.0.6"
build_runner:
dependency: "direct dev"
description:
name: build_runner
url: "https://pub.dartlang.org"
source: hosted
version: "2.1.5"
version: "2.1.7"
build_runner_core:
dependency: transitive
description:
name: build_runner_core
url: "https://pub.dartlang.org"
source: hosted
version: "7.2.2"
version: "7.2.3"
built_collection:
dependency: transitive
description:
@ -105,7 +105,7 @@ packages:
name: built_value
url: "https://pub.dartlang.org"
source: hosted
version: "8.1.3"
version: "8.1.4"
characters:
dependency: transitive
description:
@ -168,14 +168,14 @@ packages:
name: connectivity_plus
url: "https://pub.dartlang.org"
source: hosted
version: "2.1.0"
version: "2.2.0"
connectivity_plus_linux:
dependency: transitive
description:
name: connectivity_plus_linux
url: "https://pub.dartlang.org"
source: hosted
version: "1.1.1"
version: "1.2.0"
connectivity_plus_macos:
dependency: transitive
description:
@ -189,14 +189,14 @@ packages:
name: connectivity_plus_platform_interface
url: "https://pub.dartlang.org"
source: hosted
version: "1.1.1"
version: "1.2.0"
connectivity_plus_web:
dependency: transitive
description:
name: connectivity_plus_web
url: "https://pub.dartlang.org"
source: hosted
version: "1.1.0+1"
version: "1.2.0"
connectivity_plus_windows:
dependency: transitive
description:
@ -245,7 +245,7 @@ packages:
name: dart_style
url: "https://pub.dartlang.org"
source: hosted
version: "2.2.0"
version: "2.2.1"
dartz:
dependency: transitive
description:
@ -259,7 +259,7 @@ packages:
name: dbus
url: "https://pub.dartlang.org"
source: hosted
version: "0.6.6"
version: "0.6.8"
device_info_plus:
dependency: "direct main"
description:
@ -287,7 +287,7 @@ packages:
name: device_info_plus_platform_interface
url: "https://pub.dartlang.org"
source: hosted
version: "2.3.0"
version: "2.3.0+1"
device_info_plus_web:
dependency: transitive
description:
@ -439,7 +439,7 @@ packages:
name: flutter_keyboard_visibility
url: "https://pub.dartlang.org"
source: hosted
version: "5.1.0"
version: "5.1.1"
flutter_keyboard_visibility_platform_interface:
dependency: transitive
description:
@ -472,7 +472,7 @@ packages:
name: flutter_plugin_android_lifecycle
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.4"
version: "2.0.5"
flutter_quill:
dependency: "direct main"
description:
@ -589,7 +589,7 @@ packages:
name: i18n_extension
url: "https://pub.dartlang.org"
source: hosted
version: "4.1.3"
version: "4.2.0"
image_picker:
dependency: transitive
description:
@ -603,14 +603,14 @@ packages:
name: image_picker_for_web
url: "https://pub.dartlang.org"
source: hosted
version: "2.1.4"
version: "2.1.5"
image_picker_platform_interface:
dependency: transitive
description:
name: image_picker_platform_interface
url: "https://pub.dartlang.org"
source: hosted
version: "2.4.1"
version: "2.4.3"
intl:
dependency: "direct main"
description:
@ -645,14 +645,14 @@ packages:
name: json_annotation
url: "https://pub.dartlang.org"
source: hosted
version: "4.3.0"
version: "4.4.0"
lint:
dependency: transitive
description:
name: lint
url: "https://pub.dartlang.org"
source: hosted
version: "1.7.2"
version: "1.8.1"
lints:
dependency: transitive
description:
@ -715,7 +715,7 @@ packages:
name: nm
url: "https://pub.dartlang.org"
source: hosted
version: "0.4.1"
version: "0.4.2"
package_config:
dependency: transitive
description:
@ -792,14 +792,14 @@ packages:
name: path_provider
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.7"
version: "2.0.8"
path_provider_android:
dependency: transitive
description:
name: path_provider_android
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.8"
version: "2.0.11"
path_provider_ios:
dependency: transitive
description:
@ -813,28 +813,28 @@ packages:
name: path_provider_linux
url: "https://pub.dartlang.org"
source: hosted
version: "2.1.2"
version: "2.1.5"
path_provider_macos:
dependency: transitive
description:
name: path_provider_macos
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.3"
version: "2.0.5"
path_provider_platform_interface:
dependency: transitive
description:
name: path_provider_platform_interface
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.1"
version: "2.0.3"
path_provider_windows:
dependency: transitive
description:
name: path_provider_windows
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.4"
version: "2.0.5"
pedantic:
dependency: transitive
description:
@ -862,14 +862,14 @@ packages:
name: platform
url: "https://pub.dartlang.org"
source: hosted
version: "3.0.2"
version: "3.1.0"
plugin_platform_interface:
dependency: transitive
description:
name: plugin_platform_interface
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.2"
version: "2.1.2"
pool:
dependency: transitive
description:
@ -897,7 +897,7 @@ packages:
name: provider
url: "https://pub.dartlang.org"
source: hosted
version: "6.0.1"
version: "6.0.2"
pub_semver:
dependency: transitive
description:
@ -911,7 +911,7 @@ packages:
name: pubspec_parse
url: "https://pub.dartlang.org"
source: hosted
version: "1.1.0"
version: "1.2.0"
quiver:
dependency: transitive
description:
@ -925,28 +925,28 @@ packages:
name: shared_preferences
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.9"
version: "2.0.12"
shared_preferences_android:
dependency: transitive
description:
name: shared_preferences_android
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.9"
version: "2.0.10"
shared_preferences_ios:
dependency: transitive
description:
name: shared_preferences_ios
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.8"
version: "2.0.9"
shared_preferences_linux:
dependency: transitive
description:
name: shared_preferences_linux
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.3"
version: "2.0.4"
shared_preferences_macos:
dependency: transitive
description:
@ -967,14 +967,14 @@ packages:
name: shared_preferences_web
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.2"
version: "2.0.3"
shared_preferences_windows:
dependency: transitive
description:
name: shared_preferences_windows
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.3"
version: "2.0.4"
shelf:
dependency: transitive
description:
@ -1007,7 +1007,7 @@ packages:
name: source_gen
url: "https://pub.dartlang.org"
source: hosted
version: "1.1.1"
version: "1.2.1"
source_span:
dependency: transitive
description:
@ -1091,7 +1091,7 @@ packages:
name: time
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.1"
version: "2.1.0"
timing:
dependency: transitive
description:
@ -1126,6 +1126,20 @@ packages:
name: url_launcher
url: "https://pub.dartlang.org"
source: hosted
version: "6.0.18"
url_launcher_android:
dependency: transitive
description:
name: url_launcher_android
url: "https://pub.dartlang.org"
source: hosted
version: "6.0.14"
url_launcher_ios:
dependency: transitive
description:
name: url_launcher_ios
url: "https://pub.dartlang.org"
source: hosted
version: "6.0.14"
url_launcher_linux:
dependency: transitive
@ -1147,14 +1161,14 @@ packages:
name: url_launcher_platform_interface
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.4"
version: "2.0.5"
url_launcher_web:
dependency: transitive
description:
name: url_launcher_web
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.4"
version: "2.0.6"
url_launcher_windows:
dependency: transitive
description:
@ -1182,21 +1196,21 @@ packages:
name: video_player
url: "https://pub.dartlang.org"
source: hosted
version: "2.2.7"
version: "2.2.11"
video_player_platform_interface:
dependency: transitive
description:
name: video_player_platform_interface
url: "https://pub.dartlang.org"
source: hosted
version: "4.2.0"
version: "5.0.1"
video_player_web:
dependency: transitive
description:
name: video_player_web
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.4"
version: "2.0.6"
watcher:
dependency: transitive
description:
@ -1217,7 +1231,7 @@ packages:
name: win32
url: "https://pub.dartlang.org"
source: hosted
version: "2.3.0"
version: "2.3.6"
window_size:
dependency: "direct main"
description:

2
frontend/app_flowy/pubspec.yaml
View File

@ -67,7 +67,7 @@ dependencies:
url_launcher: ^6.0.2
# file_picker: ^4.2.1
clipboard: ^0.1.3
connectivity_plus: ^2.1.0
connectivity_plus: 2.2.0
easy_localization: ^3.0.0
# The following adds the Cupertino Icons font to your application.

20
frontend/scripts/makefile/flutter.toml
View File

@ -175,14 +175,26 @@ script = [
script_runner = "@shell"
[tasks.generate_language_files]
script_runner = "@shell"
script = [
"""
cd app_flowy/
cd app_flowy
flutter clean
flutter pub get
flutter pub run easy_localization:generate -S assets/translations/
flutter pub run easy_localization:generate -f keys -o locale_keys.g.dart -S assets/translations
""",
flutter pub run easy_localization:generate -f keys -o locale_keys.g.dart -S assets/translations -s en.json
"""
]
script_runner = "@shell"
[tasks.generate_language_files.windows]
script_runner = "@duckscript"
script = [
"""
cd ./app_flowy/
exec cmd.exe /c flutter clean
exec cmd.exe /c flutter pub get
exec cmd.exe /c flutter pub run easy_localization:generate -S assets/translations/
exec cmd.exe /c flutter pub run easy_localization:generate -f keys -o locale_keys.g.dart -S assets/translations
"""
]