[DOCS] Cambios en la documentación del proyecto

This commit is contained in:
Mauro Rosero P. 2024-11-30 05:09:43 -05:00
parent 62a1030271
commit 140d5bdda8
Signed by: mrosero
GPG key ID: 83BD2A5F674B7E26

View file

@ -1,43 +1,63 @@
# ODOO MR-ERP DEVELOPERS LOCAL ENVIRONMENT
## GUÍA PARA DESARROLLADORES - REV. 30/11/2024
### Preparación de ambiente local de desarrollo utilizando contenedores
### PREPARACIÓN DE AMBIENTE LOCAL PARA DESARROLLADORES
#### Perfil para desarrollador MRDEVOPS
#### Instalación del DEVELOPER TOOLS
Antes de ejecutar alguno de estos procesos asegurese de haber instalado **MRDEVOPS DEVSTOOLS** y configurado su perfil como desarrollador para **MRDEVOPS**.
(Pendiente)
#### Configuración de Perfil de Desarrollador
(Pendiente)
#### Instalación de herramientas para gestión de contenedores
Se utiliza para instalar los paquetes de gestión de contenedores (dockero podman) y otras herramientas requeridas.
#### Instalando pre-requisitos de desarrollo
$ ./bin/bootstrap.sh
Nota: Este comando requiere **privilegios de superusuario**, asegurese de tener permisos de **root** o contacte con su administrador. Actualmente, solo para distribuciones Debian. Solo se requiere si no se han instalado pre-requisitos previamente.
#### Crear carpeta para el ambiente de desarrollo odoo
Si eres parte del equipo de desarrollo de **MR DEVELOPERS**, se recomienda fuertemente que a mivel de la carpeta **$HOME** crees una carpeta **developers** que será la carpeta raiz de los diferentes proyectos de desarrollo.
#### Crear carpeta para el ambiente de desarrollo
Si eres parte del equipo de desarrollo de **MR DEVELOPERS**, se recomienda fuertemente que a nivel de la carpeta **$HOME** crees una carpeta **developers** que será la carpeta raiz de los diferentes proyectos de desarrollo.
$ mkdir $HOME/developers
### PREPARACIÓN DE AMBIENTE LOCAL PARA DESARROLLADORES
#### Crear estrucutra para ambiente de desarrollo Odoo
Dentro de la carpeta **$HOME/developers**, vas a descargar el proyecto base en la carpeta **odoo**
$ cd $HOME/developers
$ git
$ git clone git@git.rosero.one:OPENTECH/odoo.git
### Preparación de ambiente local de proyecto odoo
Nota: Requieres acceso vpn a infraestructura de desarrolladores, estar registrado como desarrollador en la plataforma git (gitea) y credencial ssh para acceso al repositorio para poder descargar el proyecto.
#### Creación de un proyecto odoo nuevo
$ ./bin/project.sh [proyecto]
### PROYECTO ODOO
Nota: Crea la estructura de carpetas y copia los archivos de gestión requeridos para un nuevo proyecto o actualiza un proyecto existente.
#### Creación o actualización de un proyecto odoo
Crea la estructura de carpetas y copia los archivos de gestión requeridos para un nuevo proyecto o actualiza un proyecto existente. Donde [proyecto] representa la carpeta que contendra el proyecto odoo.
$ cd $HOME/developers/odoo
$ ./bin/project.sh [proyecto]
#### Configurando el ambiente local de desarrollo de un proyecto odoo
$ cd [proyecto]
$ ./configure.sh
Mediante el formulario de configuración del proyecto odoo, configure las variables de ambiente que se utilizaran como parametros para la ejecución del ambiente local de desarrollo del proyecto. Es importante y requerido realizar este paso antes de iniciar el proceso de desarrollo del proyecto. El archivo generado o modificado es independiente para cada ambiente de desarrollador.
Nota: Llene el formulario de configuración para el ambiente de desarrollo. Es importante y requerido realizar este paso antes de seguir con el siguiente. Este archivo es particular para cada ambiente de desarrollador, por lo que es importante que lo ejecute al momento de inicializar su ambiente de desarrollo.
$ cd [proyecto]
$ ./configure.sh
#### Inicializando contenedor odoo local para desarrollo
$ ./build.sh
Esto configura la imagen de odoo local para incluir nuevas librerias o requisitos al contenedor de prueba
$ cd [proyecto]
$ ./build.sh
Nota: Se requiere para la construcción de la imagen odoo local desde donde se creará la imagen de contenedor del proyecto. En el futuro, este proceso será opcional; ya que tendremos una imagen disponible lista para descarga desde el repositorio. También, puede usarse para contruir la imagen si no tiene acceso a internet.