From 7b943cefc5588ae9155f82d39cbb1fdd4db34474 Mon Sep 17 00:00:00 2001
From: Manuel Aranda <maranda@qindel.com>
Date: Fri, 17 May 2024 10:15:49 +0200
Subject: [PATCH] refs #386 Crear documentacion para despliegue de OgCore en
 desarrollo

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..37bad13
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# OgCore Project
+
+## Descripción
+
+ogCore es el servicio central de OpenGnsys, diseñado para proporcionar funcionalidades a través de una API RESTful. Esta herramienta utiliza tecnología PHP, aprovechando el framework Symfony y el ORM Doctrine para gestionar la base de datos. 
+A continuación, se detallan los pasos necesarios para desplegar el proyecto en un entorno de desarrollo.
+
+## Requisitos
+
+Antes de comenzar, asegúrate de tener los siguientes requisitos:
+
+- Docker
+- Docker compose 
+
+## Instalación
+
+### Desplegar contenedores
+
+Para que no haya conflictos entre los puertos, asegúrate de que no tienes ningún servicio corriendo en los puertos 8080 y 3306.
+
+```sh
+docker compose up --build -d
+```
+
+Comprobamos que se han levantado correctamente bien los 3 contenedores de la aplicación: 
+
+```sh
+docker ps
+```
+
+Y deberiamos ver algo parecido a :
+
+- ogcore-nginx-1
+- ogcore-php-1
+- ogcore-database-1
+
+Comprobamos, que el contenedor de Nginx, tiene el puerto 8080 levantado correctamente, asi que tan solo tendremos que 
+acceder a la siguiente URL: 
+
+```sh
+http://127.0.0.1:8080/api
+```
+Si todo ha ido bien, deberiamos ver la documentación de la API de ogCore.