el-faro-del-peregrino/README.md

105 lines
2.8 KiB
Markdown

# El Faro del Peregrino
Una aplicación para acompañar el camino interior y comunitario, integrando oración, reflexión y comunidad en una experiencia visualmente inspiradora.
---
## ✨ Propósito
El Faro del Peregrino nace para ofrecer luz, guía y herramientas prácticas a quienes desean profundizar en su vida espiritual. Busca integrar recursos de oración, reflexión y comunidad en una app sencilla, cálida y significativa.
---
## 🎯 Objetivos
- Acompañar el crecimiento espiritual personal y comunitario.
- Integrar oraciones, meditaciones, lecturas y seguimiento del camino interior.
- Ofrecer una interfaz estética, accesible y acogedora.
- Sentar las bases para futuras funcionalidades:
- Comunidad de peregrinos
- Diario espiritual
- Ritmos diarios (Laudes, Vísperas, etc.)
- Notificaciones de oración
- Contenidos multimedia
---
## 🛠️ Tecnologías
- **Lenguajes:** Java / Kotlin (según evolución del módulo `app/`)
- **Build:** Gradle (con wrapper incluido)
- **IDE:** Android Studio (recomendado Flamingo o superior)
- **Arquitectura:** Modular y escalable
---
## 📁 Estructura del repositorio
```
el-faro-del-peregrino/
├── app/ # Código principal de la app
├── gradle/ # Configuración de Gradle
├── build.gradle.kts # Build script raíz
├── settings.gradle.kts # Configuración de módulos
├── gradle.properties # Propiedades globales
└── .idea/ # Configuración de 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
**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
---
## 🌅 Inspiración
> “El faro no navega por ti, pero ilumina el camino.”
Este proyecto busca ofrecer luz, calma y dirección en el viaje interior.