> [!CAUTION]
> ## [Keep Android Open](https://keepandroidopen.org/)
> ###  Your phone is about to stop being yours.
> Starting September 2026, a silent update, nonconsensually pushed by Google, will block every
> Android app whose developer hasn't registered with Google, signed their contract, paid up, and
> handed over government ID.
> **Every app and every device, worldwide, with no opt-out.**

<div align="center">
    <img width="192" height="192" src="app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp" alt="Flux Logo" />
<br>

# Flux

![Android](https://img.shields.io/badge/Android-3DDC84?style=for-the-badge&logo=android&logoColor=white)
![Kotlin](https://img.shields.io/badge/kotlin-%237F52FF.svg?style=for-the-badge&logo=kotlin&logoColor=white)
![Compose](https://img.shields.io/static/v1?style=for-the-badge&message=Jetpack+Compose&color=4285F4&logo=Jetpack+Compose&logoColor=FFFFFF&label=)
![Material](https://custom-icon-badges.demolab.com/badge/material%20you-lightblue?style=for-the-badge&logoColor=333&logo=material-you)
![LaTeX](https://img.shields.io/badge/latex-%23008080.svg?style=for-the-badge&logo=latex&logoColor=white)
![Markdown](https://img.shields.io/badge/markdown-%23000000.svg?style=for-the-badge&logo=markdown&logoColor=white)

**A lightweight Android productivity app built with Material 3.**

[<img src=".github/get-github.png" alt="Get it on GitHub" height="55">](https://github.com/chindaronit/Flux/releases/)
[<img src=".github/get_f_droid.png" alt="Get it on f-droid" height="55">](https://f-droid.org/packages/com.flux/)
[<img src=".github/IzzyOnDroid.png" alt="Get it on IzzyOnDroid" height="55">](https://apt.izzysoft.de/fdroid/index/apk/com.flux)


---

</div>

| ![Image 1](metadata/en-US/images/phoneScreenshots/screenshot1.png) | ![Image 2](metadata/en-US/images/phoneScreenshots/screenshot3.png) |
| :----------------------------------------------------------------: | :----------------------------------------------------------------: |
| ![Image 3](metadata/en-US/images/phoneScreenshots/screenshot2.png) | ![Image 4](metadata/en-US/images/phoneScreenshots/screenshot4.png) |
| ![Image 5](metadata/en-US/images/phoneScreenshots/screenshot5.png) | ![Image 6](metadata/en-US/images/phoneScreenshots/screenshot6.png) |

---

<div align="center">

## Release numbers

[![Latest Release](https://img.shields.io/github/v/release/chindaronit/Flux?style=for-the-badge)](https://github.com/chindaronit/Flux/releases)
[![License](https://img.shields.io/github/license/chindaronit/Flux?style=for-the-badge)](https://github.com/chindaronit/Flux/blob/main/LICENSE)
[![Downloads](https://img.shields.io/github/downloads/chindaronit/Flux/total?style=for-the-badge)](https://github.com/chindaronit/Flux/releases)

</div>

## 🎉 Features

* ✨ **Modern Material You Design** built with Material 3 for a clean and intuitive experience.
* 🗂️ **Flexible Workspaces** with customizable templates to organize notes, tasks, journals, habits, and events according to your workflow.
* 📝 **Rich Markdown Editor** with support for formatting, code blocks, tables, LaTeX, Mermaid diagrams, and more.
* ✅ **Advanced Task Management** with recurring tasks, reminders, progress tracking, and completion analytics.
* 📔 **Daily Journals & Notes** designed for capturing ideas, reflections, and long-form content.
* 📅 **Integrated Calendar & Events** to manage schedules and important dates in one place.
* 🔥 **Habit Tracking & Analytics** with insights, statistics, and visual progress monitoring.
* 🖼️ **Media Support** for attaching images and organizing content alongside text.
* 🔒 **Privacy-Focused Security** with optional biometric app lock and screen protection.
* 📴 **Offline-First Architecture** powered by local storage for fast and reliable access.
* 🎨 **Highly Customizable Experience** with themes, workspace organization, and personalized layouts.
* 🌍 **Open Source & Community Driven** under GPL-3.0 with frequent updates and continuous improvements.
* 🚀 **Built with Jetpack Compose** for a fast, smooth, and native Android experience.

---

## 🌎 Translations

English, Hindi, French, Portugal (Brazil), Russian, German, Spanish, Dutch, Chinese (Simple)

## 🔎 Technical Details

- **Programming Languages**: Kotlin
- **Build Tool**: Gradle with Kotlin DSL
- **Android Version**: The application targets Android SDK version 36 and is compatible with devices
  running Android SDK version 29 and above.
- **Kotlin Version**: 2.4.0
- **Java Version**: JVM Target 11.

## 🛠️ Architecture

- **MVI**: Model View ViewModel
 
## 📦 Installation

To build and run this application, you need to install the latest version of Android Studio. Then,
you can clone this repository from GitHub and open it in Android Studio.

```bash
git clone git@github.com:chindaronit/Flux.git
```

In Android Studio, select `Run > Run 'app'` to start the application.

## 🎈 Contribution

Any form of contribution is welcome! If you find a bug or have a new feature request, please create
an issue. If you want to contribute code directly to this project, you can create a pull request.


## Credits

<div align="center">
<a href="https://github.com/chindaronit/Flux/graphs/contributors">
<img src="https://contrib.rocks/image?repo=chindaronit/Flux" width="200"/>
</a>

</div>

## ⚠️ License

```text
Flux

Copyright (c) 2025 Ronit Chinda

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
```

<div align="center">
  <img src=".github/india.jpg" alt="India" height="30" style="border-radius:50%; vertical-align:middle;"> MADE IN INDIA
</div>