Dariaceli's Git
Browse code

Fix compilation issues. Add additional developer information.

Dario Rodriguez authored on 08/04/2026 17:28:37
Showing 1 changed files
README.md
History View file @ 1f6a38e
... ... 
@@ -1,5 +1,5 @@
1 1 
 # AudioNotes 📙
2 
-A simple open source audio note-taking 📝 Android application built to describe the use of Modern Android development tools. 🏗. *Made with love ❤️ by [Sammie_kt](https://github.com/certified84)*
2 
+A simple open source audio note-taking 📝 Android application built to describe the use of Modern Android development tools. 🏗. *Made with love ❤️ by [Sammie_kt](https://github.com/certified84), modified by Antartica*
3 3
4 4 
 <br />
5 5
Browse code

Initial commit (losing old history)

Dario Rodriguez authored on 08/04/2026 17:25:38
Showing 1 changed files
README.md
History View file @ 67b1d10
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,152 @@
1 
+# AudioNotes 📙
2 
+A simple open source audio note-taking 📝 Android application built to describe the use of Modern Android development tools. 🏗. *Made with love ❤️ by [Sammie_kt](https://github.com/certified84)*
3 
+
4 
+<br />
5 
+
6 
+***Find the latest stable release here👇***
7 
+
8 
+[![AudioNotes](https://github.com/certified84/AudioNote/blob/master/app/src/main/res/drawable/logo.png)](https://github.com/certified84/AudioNote/releases/latest)
9 
+
10 
+[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
11 
+     alt="Get it on F-Droid"
12 
+     height="80">](https://f-droid.org/packages/com.certified.audionote/)
13 
+
14 
+<br />
15 
+
16 
+***Find the design on figma here👇***
17 
+
18 
+[![AudioNotes](https://github.com/certified84/AudioNote/blob/master/app/src/main/res/drawable/figma_logo.png)](https://www.figma.com/file/BxFzSMNrfXy8yrQlr8XWAS/Audio-Notes-Project?node-id=3%3A594)
19 
+
20 
+<br />
21 
+
22 
+## Day Mode 🌞
23 
+Splash | Onboarding | Home(empty) | Home(content) |
24 
+--- | --- | --- | --- |
25 
+![](https://github.com/certified84/AudioNote/blob/master/Screenshots/splash_day.png) | ![](https://github.com/certified84/AudioNote/blob/master/Screenshots/onboarding_day.png) | ![](https://github.com/certified84/AudioNote/blob/master/Screenshots/home_empty_day.png) | ![](https://github.com/certified84/AudioNote/blob/master/Screenshots/home_day.png) |
26 
+
27 
+New note | Edit note | Settings | About |
28 
+--- | --- | --- | --- |
29 
+![](https://github.com/certified84/AudioNote/blob/master/Screenshots/new_note.png) | ![](https://github.com/certified84/AudioNote/blob/master/Screenshots/edit_note.png) | ![](https://github.com/certified84/AudioNote/blob/master/Screenshots/settings_day.png) | ![](https://github.com/certified84/AudioNote/blob/master/Screenshots/about_day.png)
30 
+
31 
+<br />
32 
+
33 
+## We Support Dark Mode Too 🌚
34 
+Splash | Onboarding | Home(empty) | Home(content) |
35 
+--- | --- | --- | --- |
36 
+![](https://github.com/certified84/AudioNote/blob/master/Screenshots/splash_dark.png) | ![](https://github.com/certified84/AudioNote/blob/master/Screenshots/onboarding_dark.png) | ![](https://github.com/certified84/AudioNote/blob/master/Screenshots/home_empty_dark.png) | ![](https://github.com/certified84/AudioNote/blob/master/Screenshots/home_dark.png) |
37 
+
38 
+New note | Edit note | Settings | About |
39 
+--- | --- | --- | --- |
40 
+![](https://github.com/certified84/AudioNote/blob/master/Screenshots/new_note.png) | ![](https://github.com/certified84/AudioNote/blob/master/Screenshots/edit_note.png) | ![](https://github.com/certified84/AudioNote/blob/master/Screenshots/settings_dark.png) | ![](https://github.com/certified84/AudioNote/blob/master/Screenshots/about_dark.png)
41 
+
42 
+<br />
43 
+
44 
+
45 
+## Built With 🛠
46 
+- [Kotlin](https://kotlinlang.org/) - First class and official programming language for Android development.
47 
+- [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) - For asynchronous and more..
48 
+- [Android Architecture Components](https://developer.android.com/topic/libraries/architecture) - Collection of libraries that help you design robust, testable, and maintainable apps.
49 
+  - [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Stores UI-related data that isn't destroyed on UI changes.
50 
+  - [Room](https://developer.android.com/topic/libraries/architecture/room) - SQLite object mapping library.
51 
+  - [Jetpack Navigation](https://developer.android.com/guide/navigation) - Navigation refers to the interactions that allow users to navigate across, into, and back out from the different pieces of content within your app
52 
+- [DataStore](https://developer.android.com/topic/libraries/architecture/datastore) - Jetpack DataStore is a data storage solution that allows you to store key-value pairs or typed objects with protocol buffers. DataStore uses Kotlin coroutines and Flow to store data asynchronously, consistently, and transactionally.
53 
+<!--   - [Stateflow](https://developer.android.com/kotlin/flow/stateflow-and-sharedflow) - StateFlow is a state-holder observable flow that emits the current and new state updates to its collectors.
54 
+  - [Flow](https://kotlinlang.org/docs/reference/coroutines/flow.html) - A flow is an asynchronous version of a Sequence, a type of collection whose values are lazily produced.  -->
55 
+- [Material Components for Android](https://github.com/material-components/material-components-android) - Modular and customizable Material Design UI components for Android.
56 
+- [Coil for Image loading](https://github.com/coil-kt/coil) - Kotlin based library for loading images in Android.
57 
+- [Dagger Hilt](https://github.com/google/dagger/tree/master/java/dagger/hilt) - Hilt provides a standard way to incorporate Dagger dependency injection into an Android application. For more information.
58 
+- [Easy permissions](https://github.com/vmadalin/easypermissions-ktx) - 🔓 Kotlin version of the popular google/easypermissions wrapper library to simplify basic system permissions logic on Android M or higher.
59 
+- [TimerX](https://github.com/arsvechkarev/TimerX) - Android timer and stopwatch library.
60 
+
61 
+<!-- <br />
62 
+
63 
+## Package Structure 📦
64 
+
65 
+    dev.spikeysanju.expenso # Root Package
66 
+    ├── di                  # Hilt DI Modules
67 
+    ├── data                # For data handling.
68 
+    │   ├── local           # Local Persistence Database. Room (SQLite) database
69 
+    |   │   ├── dao         # Data Access Object for Room
70 
+    |   |   |── database    # Database Instance
71 
+    |
72 
+    ├── model               # Model classes [Transaction]
73 
+    |
74 
+    |-- repo                # Used to handle all data operations
75 
+    |
76 
+    ├── view                # Activity/Fragment View layer
77 
+    │   ├── main            # Main root folder
78 
+    |   │   ├── main        # Main Activity for RecyclerView
79 
+    |   │   └── viewmodel   # Transaction ViewModel
80 
+    |   │   ├── adapter     # Adapter for RecyclerView
81 
+    │   ├── Dashboard       # Dashboard root folder
82 
+    |   |   |__ dashboard   # Dashboard
83 
+    │   ├── Add             # Add Transaction root folder
84 
+    |   |   |__ add         # Add Transaction
85 
+    │   ├── Edit            # Edit Transaction root folder
86 
+    |   |   |__ edit        # Edit Transaction
87 
+    │   ├── Details         # Add Transaction root folder
88 
+    |   |   |__ details     # Transaction Details
89 
+    │   ├── About           # About root folder
90 
+    |   |   |__ about       # About
91 
+    │   ├── Dialog          # All Dialogs root folder
92 
+    |   |   |__ dialog      # Error Dialog
93 
+    ├── utils               # All extension functions
94 
+
95 
+
96 
+<br />
97 
+ -->
98 
+
99 
+## Architecture 🗼
100 
+This app uses [***MVVM (Model View View-Model)***](https://developer.android.com/jetpack/docs/guide#recommended-app-arch) architecture.
101 
+
102 
+![](https://github.com/TheCodeMonks/Notes-App/blob/master/screenshots/ANDROID%20ROOM%20DB%20DIAGRAM.jpg)
103 
+
104 
+## Build-tool 🧰
105 
+You need to have [Android Studio](https://developer.android.com/studio) to build this project.
106 
+
107 
+<br />
108 
+
109 
+## Credit 🙌
110 
+Credit goes to [Shazomii's Notely](https://github.com/shazomii/Notely) for project inspiration
111 
+
112 
+<br />
113 
+
114 
+## Contribute 🤝
115 
+If you want to contribute to this app, you're always welcome!
116 
+See [Contributing Guidelines](https://github.com/certified84/AudioNote/blob/master/CONTRIBUTING.md).
117 
+
118 
+<br>
119 
+
120 
+## Contact 📩
121 
+Have a project? DM us at 👇
122 
+
123 
+Drop a mail to:- achiagasamson5@gmail.com
124 
+
125 
+<br>
126 
+
127 
+## Donation 💰
128 
+If this project help you reduce time to develop, you can give me a cup of coffee :)
129 
+
130 
+<a href="https://www.buymeacoffee.com/SammieKt" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
131 
+
132 
+## License 🔖
133 
+```
134 
+    Apache 2.0 License
135 
+
136 
+
137 
+    Copyright 2023 Samson Achiaga
138 
+
139 
+    Licensed under the Apache License, Version 2.0 (the "License");
140 
+    you may not use this file except in compliance with the License.
141 
+    You may obtain a copy of the License at
142 
+
143 
+       http://www.apache.org/licenses/LICENSE-2.0
144 
+
145 
+    Unless required by applicable law or agreed to in writing, software
146 
+    distributed under the License is distributed on an "AS IS" BASIS,
147 
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
148 
+    See the License for the specific language governing permissions and
149 
+    limitations under the License.
150 
+
151 
+```
152 
+