🤖 Note.AI, proyecto android desarrollado con Jetpack Compose, Hilt, Coroutines, Flow, Jetpack (Room, ViewModel), Material3, arquitectura MVVM.
Es un proyecto personal que he estado compartiendo mis avances en mis redes sociales, he seguido el desarrollo moderno en android.
- Notas: Listado y creación de notas, guardadas en base de datos local.
- Grabación de voz: Notas de voz asociadas a las notas creadas.
- Open.AI: Transcripción de audio a texto usando el modelo Whisper.
- Configuración Centralizada: Administra la configuración y claves de API con BuildKConfig.
- Interfaz Moderna: Construida con Kotlin Compose para una experiencia visual atractiva y responsiva.
git clone https://github.com/gonzalo-droid/NoteAI.git- Visita https://platform.openai.com/docs/overview
- Regístrate o inicia sesión.
- Dirígete a la sección API de tu cuenta y genera una nueva clave de API
- Recuerda que para el correcto funcionamiento debes agregar unos cuantos dolares para realizar las pruebas
- En la raíz del proyecto, crea (o actualiza) un archivo llamado local.properties y agrega la siguiente línea:
API_KEY_OPENAI=TU_CLAVE_DE_API_AQUÍ- Usa Gradle para compilar y ejecutar el proyecto:
./gradlew runPara Android, abre el proyecto en Android Studio y ejecuta la aplicación desde allí. 📱🚀
-
SDK mínimo: 26.
-
Basado en Kotlin, utilizando Coroutines + Flow para operaciones asíncronas.
-
Jetpack Compose: Kit de herramientas moderno de Android para desarrollo de UI declarativa.
-
Lifecycle: Observa los ciclos de vida de Android y gestiona los estados de UI ante cambios de ciclo de vida.
-
ViewModel: Administra datos relacionados con la UI y es consciente del ciclo de vida, asegurando la persistencia de datos tras cambios de configuración.
-
Navigation: Facilita la navegación entre pantallas, complementado con Hilt Navigation Compose para inyección de dependencias.
-
Room: Permite construir una base de datos con una capa de abstracción sobre SQLite para un acceso eficiente a los datos.
-
Hilt: Simplifica la inyección de dependencias en la aplicación.
-
Arquitectura MVVM (View - ViewModel - Model): Promueve la separación de responsabilidades y mejora el mantenimiento del código.
-
Patrón Repository: Actúa como mediador entre diferentes fuentes de datos y la lógica de negocio de la aplicación.
-
Kotlin Serialization: Serialización sin reflejos para múltiples plataformas y formatos en Kotlin.
-
ksp: API de procesamiento de símbolos en Kotlin para generación y análisis de código.
-
ktlint: Linter para kotlin. https://medium.com/@amitdogra70512/ktlint-integration-in-android-952049b9d17d
Note.AI sigue la aquitectura MVVM e implementa patrón Repository, alineado con Guía oficl de arquitectura de Google.
La arquitectura de Note.AI está estructurada en dos capas distintas: la capa de UI y la capa de datos. Cada capa cumple roles y responsabilidades específicas, que se describen a continuación.
Note.AI sigue los principios establecidos en la Guía de arquitectura de aplicaciones, lo que lo convierte en un excelente ejemplo de la aplicación práctica de conceptos arquitectónicos.
- Cada capa sigue los principios de flujo unidireccional de eventos/datos: la capa de UI envía eventos del usuario a la capa de datos, y la capa de datos proporciona flujos de datos a otras capas.
- La capa de datos opera de forma independiente de las demás capas, manteniendo su pureza sin depender de capas externas.
✅ Esta arquitectura desacoplada mejora la reutilización de componentes y la escalabilidad de la aplicación, facilitando su desarrollo y mantenimiento.
La capa de UI abarca los elementos visuales responsables de configurar las pantallas para la interacción del usuario, junto con el ViewModel, que gestiona los estados de la aplicación y restaura los datos durante los cambios de configuración.
📌 Principales características:
- Los elementos de UI observan el flujo de datos, asegurando la sincronización con la capa de datos subyacente.
- Se encarga de manejar las interacciones del usuario y reflejar los cambios en la interfaz de manera eficiente.
La capa de datos está compuesta por repositorios que manejan la lógica de negocio, como la recuperación de datos desde una base de datos local o la obtención de datos remotos desde la red. Esta capa está diseñada para priorizar el acceso sin conexión, funcionando principalmente como un repositorio offline-first de la lógica de negocio.
📌 Principales características:
- Sigue el principio de "fuente única de la verdad" (single source of truth), garantizando que todas las operaciones de datos sean centralizadas y consistentes.
- Gestiona la persistencia de datos y la comunicación con fuentes externas.
Note.AI usa open.ai para la transcripción de las notas de voz a texto.
✨ Espero que este proyecto te sea útil para seguir aprendiendo.
💡 ¡Puedes colaborar en mejoras del proyecto dejando un Pull Request!
⭐ Además, agradecería mucho que le dieras una estrella al proyecto 🤩
Aún estoy definiendo el formato 🫠, pero lo importante es empezar. ¡Suscríbete y vamos a codear!
💡 Si quieres proponer mejoras o corregir errores:
- Haz un fork del repositorio.
- Crea una rama con tu mejora.
git checkout -b feature/your-feature-name- Realiza los cambios y haz un commit.
git commit -am 'Add some feature'- Sube los cambios a tu repositorio.
git push origin feature/your-feature-name- Abre un Pull Request para revisión.
This project is licensed under the MIT License. See the LICENSE file for details.