refs #386 Crear documentacion para despliegue de OgCore en desarrollo
parent
558f8d12f2
commit
7b943cefc5
|
@ -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.
|
Loading…
Reference in New Issue