120 lines
3.5 KiB
Markdown
120 lines
3.5 KiB
Markdown
# El Faro del Peregrino
|
|
Una aplicación espiritual para acompañar el camino interior y comunitario.
|
|
|
|
El Faro del Peregrino es una aplicación diseñada para ofrecer luz, guía y herramientas prácticas a quienes desean profundizar en su vida espiritual. Su propósito es integrar oración, reflexión, comunidad y belleza visual en una experiencia sencilla y significativa.
|
|
|
|
---
|
|
|
|
✨ Objetivos del proyecto
|
|
- Crear una app que acompañe el crecimiento espiritual personal.
|
|
- Integrar recursos como oraciones, meditaciones, lecturas y seguimiento del camino interior.
|
|
- Diseñar una interfaz cálida, estética y accesible.
|
|
- Construir una base sólida para futuras funcionalidades como:
|
|
- Comunidad de peregrinos
|
|
- Diario espiritual
|
|
- Ritmos diarios (Laudes, Vísperas, etc.)
|
|
- Notificaciones de oración
|
|
- Contenidos multimedia
|
|
|
|
---
|
|
|
|
🧱 Tecnologías utilizadas
|
|
Este proyecto está construido con:
|
|
|
|
- Java / Kotlin (según evolucione el código del módulo app/)
|
|
- Gradle como sistema de construcción
|
|
- Android Studio como entorno de desarrollo
|
|
- Estructura modular preparada para escalar
|
|
|
|
---
|
|
|
|
📁 Estructura del repositorio
|
|
`
|
|
el-faro-del-peregrino/
|
|
│
|
|
├── app/ # Código fuente principal de la aplicación
|
|
├── gradle/ # Configuración interna de Gradle
|
|
├── build.gradle.kts # Configuración del proyecto
|
|
├── settings.gradle.kts # Declaración de módulos
|
|
├── gradle.properties # Propiedades del build
|
|
└── .idea/ # Configuración del IDE (Android Studio)
|
|
`
|
|
|
|
---
|
|
|
|
🚀 Cómo ejecutar el proyecto
|
|
|
|
1. Requisitos previos
|
|
- Android Studio Flamingo o superior
|
|
- JDK 17+
|
|
- Gradle (incluido en el wrapper)
|
|
|
|
2. Clonar el repositorio
|
|
`bash
|
|
git clone https://git.tatvil.es/tatiana/el-faro-del-peregrino.git
|
|
cd el-faro-del-peregrino
|
|
`
|
|
|
|
3. Abrir en Android Studio
|
|
- Selecciona Open
|
|
- Elige la carpeta del proyecto
|
|
- Android Studio descargará dependencias y sincronizará Gradle automáticamente
|
|
|
|
4. Ejecutar la app
|
|
- Conecta un dispositivo o usa un emulador
|
|
- Pulsa ▶️ Run
|
|
|
|
---
|
|
|
|
🗺️ Roadmap inicial
|
|
Este roadmap está alineado con el estilo profesional que ya usas en GitHub Issues.
|
|
|
|
Versión 0.1 — Estructura base
|
|
- [ ] Configuración inicial del proyecto
|
|
- [ ] Pantalla de bienvenida
|
|
- [ ] Navegación básica
|
|
- [ ] Tema visual inicial (colores, tipografías, iconografía)
|
|
|
|
Versión 0.2 — Contenidos espirituales
|
|
- [ ] Módulo de oraciones
|
|
- [ ] Lecturas del día
|
|
- [ ] Modo oscuro contemplativo
|
|
|
|
Versión 0.3 — Herramientas del peregrino
|
|
- [ ] Diario espiritual
|
|
- [ ] Seguimiento del camino
|
|
- [ ] Notificaciones de ritmo diario
|
|
|
|
Versión 1.0 — Comunidad
|
|
- [ ] Perfil del peregrino
|
|
- [ ] Espacios de oración compartida
|
|
- [ ] Mensajes y peticiones
|
|
|
|
---
|
|
|
|
🤝 Contribuciones
|
|
Este proyecto está en desarrollo activo.
|
|
Las ideas, mejoras y bugs se gestionan mediante GitHub Issues siguiendo un flujo profesional.
|
|
|
|
---
|
|
|
|
📜 Licencia
|
|
Pendiente de definir.
|
|
Recomendación: MIT o Apache 2.0 para proyectos abiertos; licencia privada si será app personal o comercial.
|
|
|
|
---
|
|
|
|
🕯️ Inspiración
|
|
> “El faro no navega por ti, pero ilumina el camino.”
|
|
Este proyecto nace para ofrecer luz, calma y dirección en medio del viaje interior.
|
|
|
|
---
|
|
|
|
Si quieres, puedo añadir también:
|
|
|
|
- Un logo en ASCII o SVG
|
|
- Un badge de estado del build
|
|
- Una sección de screenshots
|
|
- Una descripción más poética o más técnica, según el tono que quieras
|
|
|
|
¿Quieres que el README tenga un estilo más espiritual, más técnico o una mezcla como este? |