Skip to content

Latest commit

 

History

History
174 lines (113 loc) · 6.64 KB

README.en.md

File metadata and controls

174 lines (113 loc) · 6.64 KB
Raw
The preview for moodiary.

简体中文 | English

QQ Group: 760014526

✨ Feature

  • Cross-platform support：🌍 Compatible with Android, iOS*, Windows*, MacOS*, Linux.
  • Material Design：🎨 The interface is intuitive and user-friendly, and follows the Material Design specifications.
  • Rich text editing：📝 Supports text editing in bold, italic, underline and other formats.
  • Multimedia accessories：📷 You can add pictures, audio, video or even draw a picture to your diary.
  • Search and classification：🔍 Easily manage your diary by full-text search and categorization.
  • Custom theme：🌈 Supports light and dark modes, as well as a variety of color schemes.
  • Data security：🔒 Keep your diary safe with a password, supports biometric unlocking.
  • Export and share：🧾 Support all data import/export, as well as single diary sharing.
  • Backup and synchronization：☁ Support for LAN synchronization and WebDav backup.
  • Footprint Map : 🗺️ See your footprints on a map. Every step of your life is worth documenting.
  • Intelligent assistant：💬 Supports access to third-party large models, provides Q&A, sentiment analysis and other functions.
  • Local Natural Language Processing (NLP)：🤖 A more secure intelligent assistant that lets your diary know you better.

(Note: Cross-platform capabilities are provided by Flutter, platforms with * may need to configure your own signatures)

🔧 Main Technology stack

  • Flutter ( Cross-platform UI framework )
  • Isar ( High performance local database )
  • GetX ( State management framework )

📸 Application screenshot

The application is constantly updated, and the interface may change slightly in the new version

Mobile

Mobile

Desktop

Desktop

🚀 Installation guide

Third party SDK

Some capabilities need to apply for third-party SDKS, and the following service providers provide free versions, and the obtained keys are configured in the lab.

Weather service

Map service

Intelligent assistant

Direct mounting

Use it by downloading the compiled installation package in Release, or manually compiling it if you don't have the platform you need.

Manual compilation

Environmental requirement

  • Flutter SDK (>= 3.27.0)
  • Dart (>= 3.6.0)
  • Rust Toolchain (Latest)
  • Clang/LLVM (Latest)
  • Compatible ides (e.g. Android Studio, Visual Studio Code)

Installation procedure

Note: When packaging, you need to modify the corresponding platform configuration file, such as Android platform build.gradle

  1. Clone Repo：

    git clone https://github.com/ZhuJHua/moodiary.git
cd moodiary

  2. Installation dependency：

    flutter pub get

  3. Running application：

    flutter run

  4. Package release：

    • Android: flutter build apk
    • iOS: flutter build ipa
    • Windows: flutter build windows
    • MacOS: flutter build macos

📝 More description

Natural Language Processing (NLP)

In the experimental stage

Today, more and more industry products are beginning to incorporate AI technology, which undoubtedly greatly improves our experience. However, for diary applications, it is not acceptable to hand over the data to a large model because it is not certain that the data will be used for training. Therefore, a better approach is to adopt a local model. Although local models may not be as powerful as large models due to size limitations, they can still provide necessary help to a certain extent.

Currently, I have the following tasks integrated into the source code:

SQuAD task based on Bert pre-trained model

I used MobileBert for the SQuAD task, which is a simple machine reading comprehension task. You can ask it questions and it will return the answers you need. The model files are in the .tflite format required by TensorFlow Lite, so you can add your own model files to the assets/tflite directory.

Thanks to the following open source projects:

🤝 Contribution guide

Contributions are welcome! Please follow these steps to contribute:

  1. Fork this repository.
  2. Create a new branch(git checkout -b feature-branch-name)。
  3. Commit your changes(git commit -am 'Add some feature')。
  4. Push to branch(git push origin feature-branch-name)。
  5. Create a Pull Request.

Please make sure that your code to follow Flutter style guide and include the appropriate tests.

📄 License

This project is licensed under the AGPL-3.0 LICENSE, see the LICENSE file for details.

💖 Thanks

  • Thanks to the Flutter team for the excellent framework.
  • Special thanks to the open source community for their valuable contributions.

🥪 Sponsor

You can buy me a sandwich to keep me motivated to continue developing.

Sponsor

List of sponsors

If you want to be on the list, you can leave your link in the comments, in no particular order.

Sponsor Price
dsxksss 50 CNY
沭飏秋 10 CNY
十一 20 CNY