API para la Comisión Estatal de Busqueda del estado de Veracruz.

Descripción breve.

Esta es una API que prestara servicios a una aplicacion de escritorio y a una aplicacion movil para la Comision Estatal de Busqueda del estado de Veracruz, cuya finalidad es buscar y encontrar personas desaparecidas.

Cómo correr el proyecto.

Para cualquiera de los casos descritos debajo, el desarrollador debe tener su propio archivo .env en la raíz del proyecto. Este archivo es privado entre los desarrolladores y sus entornos de desarrollo. El proyecto incluye el archivo .env.example que brinda una configuración de ejemplo.

Docker.

Se recomienda utilizar docker ya que está compartimentalizado del sistema operativo del desarrollador, permitiéndole trabajar en un entorno funcional de manera muy rápida.

Archivo .env.

De utilizarse docker, se recomienda crear el siguiente archivo mínimo de configuración en la raiz del proyecto:

APP_NAME="API de la Comision Estatal de Busqueda y del estado de Veracruz"
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost

LOG_CHANNEL=stack
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug

DB_CONNECTION=mysql
DB_HOST=mariadb
DB_PORT=3306
DB_DATABASE=api_cebv
DB_USERNAME=sail
DB_PASSWORD=password
SCOUT_DRIVER=database

SFTP_HOST=sftp
SFTP_USERNAME=foo
SFTP_PASSWORD=pass
SFTP_PORT=22
FILESYSTEM_DISK=sftp

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

MAIL_MAILER=smtp
MAIL_HOST=mailpit
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS="hello@example.com"
MAIL_FROM_NAME="${APP_NAME}"

Inicializar el entorno de desarrollo.

Si se utiliza windows, se debe instalar wsl (seguir TODO el proceso de instalación hasta el final, generando un usuario y contraseña) y posteriormente docker. En caso de utilizar Windows y WSL, se recomienda clonar el proyecto dentro del sistema de archivos de WSL y no en las carpetas de Windows:

peloponeso@desktop:/mnt/c/Users/tanil$ cd #aqui no
peloponeso@desktop:~$ #aqui

Usualmente no se menciona, pero en caso de WSL y Windows, al instalarse docker, hay que asegurarse que la casilla ubicada en Settings > Resources > WSL Integration > Enable integration with my default WSL distro esté marcada.

Se recomienda también agregar el alias de la herramienta sail para interactuar con docker y el proyecto de manera más fácil. Se dará por hecho que este alias existe en lo que resta de este documento. Este alias solo funciona dentro de la carpeta del proyecto. En caso de bash:

echo "alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'" >> ~/.bashrc

Una vez clonado el proyecto, y con una terminal abierta dentro del directorio del proyecto clonado, se da el siguiente comando:

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v "$(pwd):/var/www/html" \
    -w /var/www/html \
    laravelsail/php82-composer:latest \
    composer install --ignore-platform-reqs

Una vez este clonado el proyecto, exista un archivo .env, este el alias del sail configurado correctamente, y se haya terminado de ejecutar el anterior comando, se da el comando desde la raiz del proyecto:

sail up

Los dos anteriores comandos tardan un poco de tiempo en ejecutarse.

Cuando el anterior termina de ejecutarse (empiezan a salir logs de sistema), quiere decir que la aplicación se está ejecutando de manera exitosa.

Se genera una llave para la aplicacion:

sail artisan generate:key

Se ejecutan las migraciones:

sail artisan migrate:fresh --seed

Refiérase a la documentación de sail para saber mas al respecto sobre el proceso de replicacion del proyecto.

El valor del campo plainTextToken debera ser enviado por el header HTTP de Authorization como un Bearer token para realizar llamadas autenticadas a la API.