README.md

README.md

+# PiRADS API
+
+## Guía de instalación
+1. Configuración:
+   1. Renombrar `config_example.yaml` a `config.yaml`
+   2. Generar una nueva `secret_key` con el comando `openssl rand -hex 32` en la terminal y copiarlo en el campo correspondiente en `config.yaml`
+2. Crear un entorno virtual: `python3 -m venv /path/to/environment`
+3. Activar el entorno virtual: `source /path/to/environment/bin/activate`
+4. Instalar las bibliotecas necesarias: `pip install -r /path/to/requirements.txt`
+5. Lanzar el servicio: `uvicorn main:app --host <HOST> --port <PORT>`
+6. Probar que funciona en http://localhost:<PORT>/docs 
\ No newline at end of file