Añadir README.md
This commit is contained in:
parent
ffb8d1d687
commit
418d04d611
|
|
@ -0,0 +1,91 @@
|
|||
# Elevate - Fitness & Nutrition AI App 🏋️♂️
|
||||
|
||||
Una aplicación Android que genera planes de ejercicios personalizados y dietas semanales utilizando inteligencia artificial.
|
||||
|
||||
## 📱 Características
|
||||
|
||||
- **Planes de ejercicios personalizados** basados en objetivos y condición física
|
||||
- **Dietas semanales** adaptadas a cada usuario
|
||||
- **Integración con ChatGPT API** para personalización inteligente
|
||||
- **Almacenamiento local** con SQLite
|
||||
- **Interfaz intuitiva** siguiendo Material Design
|
||||
|
||||
## 🚀 Instalación y Configuración
|
||||
|
||||
### Requisitos
|
||||
- Android Studio 4.0+
|
||||
- SDK Android 21+
|
||||
- Java 8+
|
||||
- Conexión a internet para la API
|
||||
|
||||
### Configuración importante ⚠️
|
||||
|
||||
**ANTES de ejecutar la app, debes configurar la ruta del SDK:**
|
||||
|
||||
1. Ve al archivo `local.properties` en la raíz del proyecto
|
||||
2. Cambia la ruta del SDK por la de tu sistema:
|
||||
```properties
|
||||
sdk.dir=C\:\\Users\\TuUsuario\\AppData\\Local\\Android\\Sdk
|
||||
# o en Mac/Linux:
|
||||
# sdk.dir=/Users/tuusuario/Library/Android/sdk
|
||||
```
|
||||
|
||||
### API Key de ChatGPT
|
||||
- Obtén tu API key en [OpenAI Platform](https://platform.openai.com/)
|
||||
- Añádela en el archivo de configuración correspondiente
|
||||
|
||||
## 🛠️ Cómo ejecutar
|
||||
|
||||
1. Clona el repositorio:
|
||||
```bash
|
||||
git clone https://github.com/tu-usuario/elevate-app.git
|
||||
```
|
||||
|
||||
2. Abre el proyecto en Android Studio
|
||||
|
||||
3. **Configura la ruta del SDK** en `local.properties` (paso crucial)
|
||||
|
||||
4. Sincroniza el proyecto con Gradle
|
||||
|
||||
5. Ejecuta en un dispositivo o emulador Android
|
||||
|
||||
## 🔧 Tecnologías utilizadas
|
||||
|
||||
- **Java** - Lenguaje principal
|
||||
- **Android SDK** - Framework nativo
|
||||
- **SQLite** - Base de datos local
|
||||
- **ChatGPT API** - Inteligencia artificial
|
||||
- **Material Design** - Diseño de interfaz
|
||||
|
||||
## 📂 Estructura del proyecto
|
||||
|
||||
```
|
||||
app/
|
||||
├── src/main/java/
|
||||
│ ├── activities/ # Actividades principales
|
||||
│ ├── adapters/ # Adaptadores para RecyclerView
|
||||
│ ├── database/ # Gestión de SQLite
|
||||
│ └── models/ # Modelos de datos
|
||||
├── src/main/res/
|
||||
│ ├── layout/ # Diseños XML
|
||||
│ └── values/ # Colores, strings, estilos
|
||||
└── local.properties # ⚠️ Configurar ruta SDK aquí
|
||||
```
|
||||
|
||||
## 👤 Funcionalidades principales
|
||||
|
||||
1. **Registro y login** de usuarios
|
||||
2. **Recopilación de datos** personales (edad, peso, objetivos, etc.)
|
||||
3. **Generación automática** de planes de ejercicio
|
||||
4. **Creación de dietas** personalizadas
|
||||
5. **Gestión de perfil** y regeneración de planes
|
||||
|
||||
## 📝 Notas
|
||||
|
||||
- La app requiere conexión a internet para generar nuevos planes
|
||||
- Los datos se almacenan localmente para acceso offline
|
||||
- Compatible con Android 5.0 (API 21) en adelante
|
||||
|
||||
---
|
||||
|
||||
**Importante:** Recuerda siempre configurar correctamente la ruta del SDK en `local.properties` antes de ejecutar la aplicación para evitar errores de compilación.
|
||||
Loading…
Reference in New Issue