LeOS-Brain/README.md

63 lines
3.2 KiB
Markdown
Raw Normal View History

2023-12-10 12:28:26 +01:00
![Stars](https://img.shields.io/github/stars/mhss1/mybrain?style=social)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
<img align="left" width="80" height="80" src="https://user-images.githubusercontent.com/58703865/169863670-eee3c8f1-1308-4eb2-9aea-f7c0a47e6a31.png" alt="app icon">
# My Brain
### Open-source, All-in-one productivity app for Tasks, Notes, Calendar, Diary and Bookmarks.
<div align="left">
<img src = "https://user-images.githubusercontent.com/58703865/169859205-54c0b8f3-7423-4c2a-9a9b-9e43861814c0.png" width ="160" />
<img src = "https://user-images.githubusercontent.com/58703865/169859229-04fbad81-80f8-4b47-8d8a-0242a16a1f8b.png" width ="160" />
<img src = "https://user-images.githubusercontent.com/58703865/169859305-7127fcf4-12fe-4f52-a605-c8b4c77917df.png" width ="160" />
<img src = "https://user-images.githubusercontent.com/58703865/169859328-1abddd5a-d88c-4877-9078-9e12e311c465.png" width ="160" />
<img src = "https://user-images.githubusercontent.com/58703865/169859351-5608acc9-b99e-41c4-8048-6d036e8c189b.png" width ="160" />
</div>
[screenshots made by previewed](https://previewed.app/template/00CBF3F6)
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
height="80">](https://f-droid.org/packages/com.mhss.app.mybrain)
[<img src="https://camo.githubusercontent.com/70bffd8873ab81e1bb0bccc44e488c3a989e3bd5/68747470733a2f2f692e6962622e636f2f71306d6463345a2f6765742d69742d6f6e2d6769746875622e706e67"
alt="Get it on GitHub"
height="80">](https://github.com/mhss1/MyBrain/releases/latest)
## Features
- Private with no data collection and no internet permission at all.
- Create tasks with priority, sub-tasks, description and due date and reminders.
- Create Notes that supports markdown which enables you to use Headers, lists, links etc..
- Record your mood daily and view your mood summary with beautiful graphs.
- Save bookmarks for later by using the share menu from any other app.
- View your calendar events in a modern view and also with a beautiful home screen widget.
- Dashboard screen to see your tasks, calendar events, and more to see your day at a glance.
## Technologies
- 100% Kotlin.
- Made Using Jetpack Compose.
- Widgets made with Compose Glance.
- Following Clean Architecture approach.
- Following MVVM Architectural Design Pattern.
### Used in the app :
- Room DB
- Hilt
- Preferences DataStore
- Kotlin coroutines
- Kotlin Flows
- Alarm Manager
- Jetpack Compose
- Compose Glance
## Contributing
To get started, take a look at [CONTRIBUTING.md](CONTRIBUTING.md).
---
Icons Attribution
<a href="https://www.flaticon.com/free-icons/paper" title="paper icons">Paper icons created by Freepik - Flaticon</a>
<a href="https://www.flaticon.com/free-icons/list" title="list icons">List icons created by Freepik - Flaticon</a>
<a href="https://www.flaticon.com/free-icons/calendar" title="calendar icons">Calendar icons created by Freepik - Flaticon</a>
<a href="https://www.flaticon.com/free-icons/bookmark" title="bookmark icons">Bookmark icons created by Freepik - Flaticon</a>
<a href="https://www.flaticon.com/free-icons/book" title="book icons">Book icons created by Freepik - Flaticon</a>