|
||
---|---|---|
bin | ||
config | ||
docker | ||
migrations | ||
public | ||
src | ||
templates | ||
tests | ||
.env | ||
.env.test | ||
.gitignore | ||
README.md | ||
compose.override.yaml | ||
composer.json | ||
composer.lock | ||
docker-compose.yaml | ||
phpunit.xml.dist | ||
symfony.lock |
README.md
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.
docker compose up --build -d
Comprobamos que se han levantado correctamente bien los 3 contenedores de la aplicación:
docker ps
Y deberiamos ver algo parecido a :
- ogcore-nginx
- ogcore-php
- ogcore-database
Instalamos dependencias
docker exec ogcore-php composer install
docker exec ogcore-php php bin/console lexik:jwt:generate-keypair --overwrite
Comprobamos, que el contenedor de Nginx, tiene el puerto 8080 levantado correctamente, asi que tan solo tendremos que acceder a la siguiente URL:
http://127.0.0.1:8080/api/docs
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:
docker exec ogcore-php php bin/console doctrine:migrations:migrate --no-interaction
docker exec ogcore-php php bin/console doctrine:fixtures:load --no-interaction
docker exec ogcore-php php bin/console app:load-default-user-groups
Test
Para ejecutar los test, ejecutamos el siguiente comando:
docker compose exec php bin/phpunit