Skip to content

Latest commit

 

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Aquí tienes un ejemplo de un archivo README.md bien estructurado para tu proyecto, basado en las mejores prácticas del artículo y adaptado a las necesidades específicas de tu proyecto:


# 🛠️ Proyecto Full Stack: Aplicación Ionic + Spring Boot

![Aplicación Full Stack](https://via.placeholder.com/1200x300.png?text=Tu+Logo+o+Banner+del+Proyecto)

## 🚀 Descripción del Proyecto

Esta es una aplicación **Full Stack** desarrollada utilizando tecnologías modernas como **Ionic con React** para el frontend, **Spring Boot** para el backend y **MySQL** como base de datos. El objetivo del proyecto es ofrecer una plataforma para gestionar usuarios, clasificaciones y funcionalidades dinámicas que pueden integrarse fácilmente con cualquier sistema.

---

## 🛡️ Estado del Proyecto

<p align="center">
  <img src="https://img.shields.io/badge/STATUS-En%20Desarrollo-green">
</p>

---

## ✨ Funcionalidades

- Registro e inicio de sesión de usuarios.
- Gestión de perfiles.
- Clasificación de usuarios según niveles y experiencia.
- Sistema de misiones diarias para incentivar la actividad.
- Panel administrativo para gestionar datos de usuarios (futuro).

---

## 📁 Acceso al Proyecto

Puedes clonar este repositorio para explorar el código y desplegarlo en tu entorno local:

```bash
git clone https://github.com/tuusuario/tu-repositorio.git
```

🛠️ Tecnologías Utilizadas

Frontend

  • Ionic con React y TypeScript
  • Nginx para servir la aplicación de producción

Backend

  • Spring Boot
  • Java 11/17
  • JPA/Hibernate

Base de Datos

  • MySQL 8.0

DevOps

  • Docker y Docker Compose para contenerización
  • Nginx como servidor web para el frontend

📜 Requisitos Previos

Asegúrate de tener instalado en tu máquina:

  • Docker y Docker Compose
  • Git

📦 Cómo Ejecutar el Proyecto

1. Configura las Variables de Entorno

Crea un archivo .env en la raíz del proyecto con el siguiente contenido:

MYSQL_ROOT_PASSWORD=tu_contraseña_mysql
MYSQL_DATABASE=nombre_base_datos
MYSQL_USER=usuario
MYSQL_PASSWORD=contraseña_usuario
SPRING_DATASOURCE_URL=jdbc:mysql://db:3306/nombre_base_datos
SPRING_DATASOURCE_USERNAME=usuario
SPRING_DATASOURCE_PASSWORD=contraseña_usuario

2. Construye y Levanta los Contenedores

docker-compose up --build

Esto realizará lo siguiente:

  • Creará una red de Docker para el frontend, backend y base de datos.
  • Inicializará automáticamente la base de datos con el script init.sql.

3. Accede a la Aplicación


🗂️ Estructura del Proyecto

├── backend/                # Código fuente del backend (Spring Boot)
├── frontend/               # Código fuente del frontend (Ionic + React)
├── nginx/                  # Configuración del servidor Nginx
│   └── nginx.conf
├── mysql-init/             # Script para inicializar la base de datos
│   └── init.sql
├── docker-compose.yml      # Archivo de configuración para Docker Compose
├── .env                    # Variables de entorno
└── README.md               # Documentación del proyecto

📜 Configuración del Backend

El backend está configurado para conectarse automáticamente a la base de datos MySQL y crear las tablas necesarias al iniciar.

Configuración:

  • Puerto: 8080
  • Conexión a la base de datos: Especificada en .env

El backend expone las siguientes rutas:

  • Autenticación: /auth/login, /auth/register
  • Usuarios: /api/users
  • Clasificación: /api/ranking
  • Misiones: /api/missions

🖥️ Configuración del Frontend

El frontend está diseñado con Ionic y utiliza Nginx para servir la aplicación en producción.

Configuración:

  • Puerto: 80
  • Ruta base: /

El frontend utiliza el archivo src/config.ts para apuntar al backend. Asegúrate de que la URL coincida con la del backend.

INSERT INTO usuarios (nombre, email, password) VALUES ('Admin', 'admin@example.com', 'contraseña_hash');


---

## 📄 Licencia

Este proyecto está bajo la licencia MIT. Consulta el archivo [LICENSE](LICENSE) para más detalles.

---

## ✨ Autores

| [<img src="https://avatars.githubusercontent.com/u/12345678?v=4" width=115><br><sub>JerePrograma</sub>](https://github.com/JerePrograma) |
| :---: |

---

## 📞 Contacto

Si tienes dudas o sugerencias, no dudes en abrir un issue en el repositorio o contactarme a través de mi [perfil de GitHub](https://github.com/JerePrograma).

About

Aplicación web para seguimiento de ejercicios con temática de Solo Leveling

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages