refs #386. Crear documentacion para despliegue de entorno de desarrollo

pull/4/head
Manuel Aranda Rosales 2024-05-21 11:17:12 +02:00
commit aa946396be
1 changed files with 10 additions and 11 deletions

View File

@ -1,8 +1,8 @@
# OgCore Project
# 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.
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
@ -10,7 +10,7 @@ A continuación, se detallan los pasos necesarios para desplegar el proyecto en
Antes de comenzar, asegúrate de tener los siguientes requisitos:
- Docker
- Docker compose
- Docker compose
## Instalación
@ -22,7 +22,7 @@ Para que no haya conflictos entre los puertos, asegúrate de que no tienes ning
docker compose up --build -d
```
Comprobamos que se han levantado correctamente bien los 3 contenedores de la aplicación:
Comprobamos que se han levantado correctamente bien los 3 contenedores de la aplicación:
```sh
docker ps
@ -34,23 +34,22 @@ Y deberiamos ver algo parecido a :
- 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:
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
http://127.0.0.1:8080/api/docs
```
Si todo ha ido bien, deberiamos ver la documentación de la API de ogCore.
Si todo ha ido bien, deberiamos ver la documentación de la API de ogCore.
Para poder actualizar la base de datos:
Para inicializar la base de datos:
```sh
docker exec ogcore-php symfony console doctrine:fixtures:load --no-interaction
docker exec ogcore-php symfony console doctrine:migrations:migrate --no-interaction
```
```sh
docker exec ogcore-php symfony console doctrine:migrations:migrate -no-interaction
docker exec ogcore-php symfony console doctrine:fixtures:load --no-interaction
```