siu-toba/template-proyecto-toba

Creación de un nuevo proyecto Toba

Descarga

• Descargar este proyecto como zip (botón verde 'clone or download'). Luego extraerlo dentro de una carpeta deseada
• Modificar el archivo composer.json reemplazando la entrada name con lo que corresponda.

Instalación y creación del proyecto con Docker

• Instalar Docker y Docker Compose
• Reemplazar en el archivo docker-compose.yml todas las apariciones del string <NOMBRE PROYECTO> por el nombre real del proyecto (los requisitos de este nombre son los mismos que para un identificador en PHP).
• Ejecutar el comando

docker-compose up -d

• Conectarse al contenedor

docker exec -it <NOMBRE PROYECTO> bash

• Instalar Pre-requisitos usando las siguientes guias:, _(*1)

  • Composer
  • Yarn
  • Git

• Ejecutar en la carpeta el comando, _(*2)

cd /var/local/<NOMBRE PROYECTO>
composer install

• Ejecutar el comando y proveer los datos requeridos

bin/toba instalacion instalar

• Ejecutar el comando

bin/crear-proyecto.sh

• Reiniciar apache

service apache2 reload

Listo, el proyecto ya se puede acceder desde la url http://localhost:7008/toba_editor/3.3.
Las credenciales por defecto son toba:toba, _(*3)

Recomendamos en este punto crear el commit inicial en el CVS. Si no se está usando Git hay que ignorar los directorios y archivos que se ecuentran en el archivo .gitignore, si se utiliza Git no es necesario., _(*4)

La estructura del proyecto nuevo quedó en la raíz., _(*5)

Trabajando

Permisos de los archivos

Por defecto el contenedor crea los archivos de código con permisos de root, esto puede ser molesto. Dentro del directorio del proyecto (fuera del contenedor) ejecutar esto por única vez para poder editar tranquilamente los archivos:, _(*6)

sudo chown -R $USER:$USER metadatos php temp www proyecto.ini

Una vez hecho esto se puede levantar con cualquier IDE la carpeta del proyecto y trabajar normalmente., _(*7)

Carpeta de instalación de Toba

Por defecto la carpeta de instalación queda montada en la carpeta llamada instalacion en la raíz del proyecto. Si se desea cambiar esto se hace desde la sección volumes del docker-compose.yml, _(*8)

Comandos administrativos

Utilizando la instalación de Docker se recomiendo correr los comandos administrativos (exportar y regenerar metadatos e interacción con el CVS) desde dentro del contenedor del proyecto. Para acceder al mismo se ejecuta el siguiente comando:, _(*9)

docker exec -it <NOMBRE PROYECTO> bash

Instalación en Máquina Host (Ubuntu)

• Instalar Apache o manualmente
• Instalar [PHP] (http://php.net/manual/en/install.unix.debian.php) o [manualmente] (http://php.net/manual/es/install.php)
• Instalar [Postgres] (https://www.postgresql.org/download/linux/ubuntu/) o [manualmente] (https://www.postgresql.org/docs/current/static/install-procedure.html)
• Instalar Subversion y/o Git
• Instalar Graphviz
• Instalar Composer
• Instalar Yarn
• Instalar Git

• Editar el/los archivos de configuracion de PHP(php.ini) de acuerdo a la plataforma y cambiar las siguientes configuraciones:, _(*10)

  #Mínimos
  magic_quotes_gpc  =  Off
  magic_quotes_runtime  =  Off
  
  #Recomendados
  error_reporting  =  E_ALL           #Solo para desarrollo
  display_errors = On                 #Solo para desarrollo
  memory_limit = 512M
  post_max_size = 8 M
  upload_max_filesize = 8 M
  

• Instalar o activar las siguientes extensiones de PHP, _(*11)

  extension=curl.so
  extension=gd.so
  extension=json.so
  extension=pdo.so
  extension=pdo_pgsql.so
  extension=mbstring.so
  extension=mcrypt.so
  extension=phar.so
  extension=xsl.so
  extension=xmlwriter.so
  extension=xmlreader.so
  extension=zip.so
  extension=zlib.so        
  

• Ejecutar en la carpeta del proyecto el comando
  shell composer install

• Ejecutar los comandos, _(*12)

  export TOBA_INSTALACION_DIR=`pwd`/instalacion   
  bin/toba instalacion instalar
  

  E indicar los valores para los parametros solicitados, _(*13)

  Otra alternativa es renombrar el archivo parameters.yml.dist y completarlo con los valores pertinentes para los datos alli presentes, luego de ello podemos ejecutar lo siguiente:, _(*14)

  export TOBA_INSTALACION_DIR=`pwd`/instalacion   
  bin/toba instalacion_silenciosa instalar --archivo_configuracion parameters.yml
  

Creación del proyecto

• Ejecutar el comando, _(*15)

  bin/toba proyecto crear -p <NOMBRE PROYECTO> -d `pwd`
  

• Crear un link simbolico al archivo instalacion/toba.conf para que Apache pueda servirlo, _(*16)

  sudo ln -s `pwd`/instalacion/toba.conf  /etc/apache2/sites-available/<NOMBRE PROYECTO>.conf
  

• Activar el sitio en la configuración de Apache, _(*17)

  sudo a2ensite <NOMBRE PROYECTO>
  

• Activar el modulo de reescritura de Apache, _(*18)

  sudo a2enmod rewrite
  

• Reiniciar apache, _(*19)

  service apache2 reload
  

• Listo, el proyecto ya se puede acceder desde la url http://localhost/toba_editor/3.3.
  Las credenciales son las que haya incluido en los parametros solicitados, _(*20)

  Recomendamos en este punto crear el commit inicial en el VCS (Version Control System) elegido. Si no se está usando Git hay que ignorar los directorios y archivos que se ecuentran en el archivo .gitignore, si se utiliza Git no es necesario., _(*21)

  La estructura del proyecto Toba nuevo quedó en la raíz., _(*22)

Trabajando

Carpeta de instalación de Toba

Por defecto la carpeta de instalación queda montada en la carpeta llamada instalacion en la raíz del proyecto., _(*23)

Comandos administrativos

Para persistir las modificaciones realizadas con toba_editor, se recomienda correr los comandos administrativos en interacción con el VCS * Ejecutar el lanzador de comandos para obtener un listado de opciones: shell bin/toba, _(*24)

• Otra opción es cargar primero las variables de entorno, para ello ejecutar al abrir una nueva consola el comando, _(*25)

   . instalacion/entorno_toba.env
  

  o en el caso de windows, _(*26)

   entorno_toba_version.bat
  

  Luego de ello acceder normalmente a los comandos administrativos, mediante el comando lanzador bin/toba., _(*27)