Lotus - Smart Markdown Editor for Android

Русскую версию смотреть тут: README.ru.md.

Description

The Lotus application is a powerful note management tool that allows users to create, edit, and organize their notes through a user-friendly interface.

Technologies

• Programming Language: Kotlin
• Framework: Android Jetpack
• Libraries:
  • AndroidX
  • Compose for UI
  • Retrofit for network requests
  • Room for database management
  • Coroutines for asynchronous programming

Groq Integration

The Lotus application is integrated with Groq, allowing users to utilize advanced artificial intelligence models for text generation and error correction. Groq provides the ability to automatically process text during text transcription, including correcting grammatical errors and improving structure using advanced artificial intelligence techniques.

Installation

1. Clone the repository:

   git clone https://github.com/FLEXIY0/Lotus-Smart-Markdown-Editor-for-Android.git

2. Navigate to the project directory:

   cd Lotus

3. Install dependencies:

   ./gradlew build

Usage

• Run the application on an emulator or a real Android device.
• Create new notes, edit existing ones, and manage them through an intuitive interface.

Features

• Create, edit, and delete notes.
• Support for version control of notes.
• Ability to pin notes for quick access.
• Integration with speech recognition for convenient text input.
• Trash management for recovering deleted notes.
• Create checkboxes.
• Create timestamps.
• Add notifications.
• Upload media files (currently only photos are supported).
• Support for metadata such as creation and modification times of notes.
• Support for two languages: Russian and English.

Demonstration

Watch the video 1080p

test.mp4

Project Structure

• The root directory contains build files and configuration files.
• The app directory contains the source code of the application:
  • app/src/main/java – implementation of the user interface and business logic;
  • app/src/main/res – application resources (layouts, images, strings);
  • app/assets – additional files.
• The gradlew, gradlew.bat, settings.gradle.kts, and build.gradle.kts files manage the build and dependencies of the project.

Requirements

• The application supports devices with Android API 26 and above.
• The project is built using compileSdk and targetSdk version 34.
• It is recommended to use the latest version of Android Studio to work with the project.

How to Contribute

• Fork the repository and create your branch for implementing new features or fixes.
• Submit a pull request for discussion of changes.
• Follow existing naming conventions and architectural principles of the project.
• Write tests for new functionality.
• Report any bugs found through Issues.

Testing

To run tests, execute the command:

./gradlew test

License

This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike (CC BY-NC-SA) license. You can use, modify, and distribute this project, but not for commercial purposes. All derivative works must be licensed under the same terms.