ClimWeb Documentation
Ejecutando el entorno de desarrollo¶
Si desea contribuir a Climweb, necesita configurar el entorno de desarrollo en su computadora local. La mejor manera de hacerlo es a través de Docker Compose para que puedas iniciar la aplicación con la menor cantidad de molestias.
Nota
Para la implementación en producción, visite https://github.com/wmo-raf/climweb-docker
Clonando el repositorio¶
El primer paso es clonar el repositorio de Climweb desde GitHub. Puedes hacer esto ejecutando el siguiente comando en tu terminal:
$ git clone https://github.com/wmo-raf/climweb.git
$ cd climweb
Crear archivo .env¶
A continuación, debe crear un archivo de entorno que contenga la configuración necesaria para el entorno de desarrollo. Puede hacerlo copiando el archivo de entorno de desarrollo de muestra proporcionado en el repositorio:
$ cp .env.dev.sample .env
Actualice el archivo .env con la configuración requerida. Consulte la sección Variables de entorno para obtener referencia sobre las variables de entorno disponibles y sus descripciones.
Inicio rápido¶
Si está familiarizado con git y Docker Compose, ejecute estos comandos para iniciar el entorno de desarrollo de Climweb localmente; de lo contrario, comience desde la sección Requisitos de instalación a continuación.
$ git clone https://github.com/wmo-raf/climweb.git
# Our supplied ./dev.sh script wraps Docker Compose setting the correct env vars for
# you to get hot code reloading working well.
$ ./dev.sh
# Run ./dev.sh help for further details.
$ ./dev.sh help
Requisitos de instalación¶
Si aún no ha instalado Docker y Docker Compose en su computadora, puede hacerlo siguiendo las instrucciones en https://docs.docker.com/desktop y https://docs.docker.com/compose/install
Nota
La versión 19.03 de Docker es el mínimo requerido para construir Climweb. Sin embargo, se recomienda encarecidamente que instale la última versión de Docker disponible. Verifique que su ventana acoplable esté actualizada ejecutando docker -v.
También necesitará tener instalado git, lo cual puede hacer siguiendo las instrucciones en https://www.linode.com/docs/development/version-control/how-to-install-git-on-linux-mac-and-windows.
Una vez que haya terminado de instalar todo el software requerido, debería poder ejecutar los siguientes comandos en su terminal.
$ docker -v
Docker version 28.1.1, build 4eba377
$ docker compose version
Docker Compose version v2.35.1-desktop.1
$ git --version
git version 2.37.1
Si todos los comandos devuelven algo similar a lo descrito en el ejemplo, ¡entonces está listo para continuar!
Iniciando el entorno de desarrollo¶
Primero, necesitas clonar el repositorio. Ejecute los siguientes comandos para clonar la rama principal. Si no está familiarizado con git clone, esto descargará una copia del código de Climweb a su computadora.
$ git clone https://github.com/wmo-raf/climweb.git
Cloning into 'climweb'...
...
$ cd climweb
Ahora que tenemos nuestra copia del repositorio y hemos cambiado los directorios al climweb recién creado, podemos abrir los contenedores.
Si no desea utilizar el script dev.sh proporcionado, puede ejecutar el siguiente comando para iniciar el entorno de desarrollo:
$ docker compose -f docker-compose.yml -f docker-compose.dev.yml up
Nota
Tenga en cuenta que el archivo docker-compose.dev.yml se utiliza para anular el archivo predeterminado docker-compose.yml con configuraciones específicas de desarrollo.
Accediendo a la aplicación web¶
Una vez que los contenedores estén en funcionamiento, puede acceder a la aplicación Climweb en su navegador web en http://localhost:8000. El puerto se puede cambiar en el archivo .env si es necesario modificando la variable CLIMWEB_DEV_PORT.
Creando un superusuario¶
Para crear un superusuario para la aplicación Climweb, puede ejecutar el siguiente comando en una ventana de terminal separada:
$ docker compose -f docker-compose.yml -f docker-compose.dev.yml exec climweb climweb createsuperuser
Mantenga el contenedor en funcionamiento¶
Los contenedores deben seguir funcionando mientras se desarrolla. También monitorean los cambios de archivos y se actualizan automáticamente, por lo que no necesita preocuparse por recargarlos. Cualquier cambio en el código activará una recarga y podrás ver los cambios inmediatamente.