Commit b9880d07 authored by Teodoro David Nina Mamani's avatar Teodoro David Nina Mamani
Browse files

Actualización de la documentacion

parent d8c4d748
...@@ -2,168 +2,246 @@ ___ ...@@ -2,168 +2,246 @@ ___
## INSTALACIÓN ## INSTALACIÓN
___ ___
# Prerrequisitos Prerrequisitos
--------------
La siguiente instalación y configuración realizado en Sistema Operativo Debian Jessie La siguiente instalación y configuración realizado en Sistema Operativo
Debian Jessie
**Creacion de Usuario en Sistema Operativo** **Creacion de Usuario en Sistema Operativo**
```sh ``` {.sourceCode .sh}
$ sudo adduser usuarioPersonal $ sudo adduser usuario_proyecto
``` ```
**Agregar Usuario al grupo sudo del Sistema Operativo** **Agregar Usuario al grupo sudo del Sistema Operativo**
```sh ``` {.sourceCode .sh}
$ sudo adduser usuarioPersonal sudo $ sudo adduser usuario_proyecto sudo
``` ```
**Instalando GIT** **Instalando GIT**
Git (pronunciado "guit" ) es un software de control de versiones diseñado por Linus Torvalds, pensando en la eficiencia y la confiabilidad del mantenimiento de versiones de aplicaciones cuando éstas tienen un gran número de archivos de código fuente. Git (pronunciado “guit” ) es un software de control de versiones
diseñado por Linus Torvalds, pensando en la eficiencia y la
confiabilidad del mantenimiento de versiones de aplicaciones cuando
éstas tienen un gran número de archivos de código fuente.
Para la instalación realizar: Para la instalación realizar:
```sh
``` {.sourceCode .sh}
$ sudo apt-get install git $ sudo apt-get install git
``` ```
**Instalando nodejs y npm** **Instalando nodejs y npm**
>Node.js es un entorno de desarrollo basado en JavaScript que permite la ejecución de servicios y eventos del lado del servidor. Existen múltiples librerias que podriamos incorporar a Node,js, esto lo haremos a través de su administrador NPM. Node.js es un entorno de desarrollo basado en JavaScript que permite la
ejecución de servicios y eventos del lado del servidor. Existen
múltiples librerías que podríamos incorporar a Node,js, esto lo haremos
a través de su administrador **NPM**.
**Instalar Curl**
> Durante el proceso de instalación necesitaremos este binario.
**Instalar Curl***
>Durante el proceso de isntalación necesitaremos este binario. ``` {.sourceCode .sh}
```sh
$ sudo apt-get install curl $ sudo apt-get install curl
``` ```
> **Añadiendo los repositorios de NodeSource**
**Añadiendo los repositorios de NodeSource***
>Para añadir los repositorios de node.js version 4.x debemos de ejecutar: Para añadir los repositorios de node.js version 4.x debemos de ejecutar:
```sh
``` {.sourceCode .sh}
$ sudo curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash - $ sudo curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
``` ```
> **Instalando Node.js**
**Instalando Node.js***
Ahora realizaremos la instalación de node v4.4.0
>Ahora realizaremos la instalacion de node v4.4.0 ``` {.sourceCode .sh}
```sh
$ sudo apt-get install -y nodejs $ sudo apt-get install -y nodejs
``` ```
> **Instalando NPM**
**Instalando NPM***
npm(node package manager) es el gestor de paquetes de Node.js, nos
permitira descargar librerias y enlazarlas.
Antes debemos de hacer la instalación de paquetes necesarios para un
copilado correcto.
``` {.sourceCode .sh}
$ sudo apt-get install build-essential
```
>npm(node package manager) es el gestor de paquetes de Node.js, nos permitira descargar librerias y enlazarlas. Debemos de seguir de la siguiente manera:
>Debemos de seguir de la sigueinte manera: ``` {.sourceCode .sh}
```sh
$ git clone http://github.com/isaacs/npm.git $ git clone http://github.com/isaacs/npm.git
$ cd npm $ cd npm
$ sudo make install $ sudo make install
``` ```
>Para verificar si esta instalado correctamente: Para verificar si esta instalado correctamente:
```sh
``` {.sourceCode .sh}
$ npm info $ npm info
``` ```
**Instalando BOWER** **Instalando Gruntjs**
Bower te permite administrar los componentes que contienen HTML, CSS, JavaScript, fuentes e incluso archivos de imagen. Bower no concatenar o minify código o hacer cualquier otra cosa - sólo instala las versiones correctas de los paquetes que necesita y sus dependencias.
```sh
$ npm install -g bower
```
**Instalando Ruby** Un manejador de tareas, permite minimización, compilación, pruebas
unitarias, y mucho más.
Un lenguaje de programación dinámico y de código abierto. ``` {.sourceCode .sh}
```sh $ sudo npm install -g grunt-cli
$ sudo apt-get install ruby-full
``` ```
Backend-End
===========
**Instalando Gruntjs** **Instalando SASS**
Un manejador de tareas, permite minimización, compilación, pruebas unitarias, y mucho más. ``` {.sourceCode .sh}
```sh $ sudo gem install sass
$ sudo npm install -g grunt-cli
``` ```
**Instalando PostgreSQL** **Instalando PostgreSQL**
PostgreSQL es un potente sistema de base de datos objeto-relacional de código abierto. PostgreSQL es un potente sistema de base de datos objeto-relacional de
código abierto.
***Instalación*** - Instalación
```sh
``` {.sourceCode .sh}
$ sudo apt-get install postgresql postgresql-client postgresql-contrib $ sudo apt-get install postgresql postgresql-client postgresql-contrib
``` ```
***Configuración*** - Configuración
Para poder realizar operaciones relacionadas con PostgreSQL:
> Para poder realizar operaciones relacionadas con
```sh
``` {.sourceCode .sql}
PostgreSQL: >
$ sudo su - postgres $ sudo su - postgres
``` ```
Creando usuario para el sistema: Creando usuario para el sistema:
```sqldb
``` {.sourceCode .sql}
postgres=# CREATE USER usuarioPersonal PASSWORD 'password'; postgres=# CREATE USER usuarioPersonal PASSWORD 'password';
``` ```
Cambiando privilegios de usuario: Cambiando privilegios de usuario:
```sqlDB
``` {.sourceCode .sql}
postgres=# ALTER ROLE usuarioPersonal WITH SUPERUSER; postgres=# ALTER ROLE usuarioPersonal WITH SUPERUSER;
``` ```
Creando la Base de Datos para el sistema Creando la Base de Datos para el sistema
```sqldb
``` {.sourceCode .sql}
postgres=# CREATE DATABASE moduloPersonalDb WITH OWNER usuarioPersonal; postgres=# CREATE DATABASE moduloPersonalDb WITH OWNER usuarioPersonal;
``` ```
## Clonar repositorio **Clonar repositorio**
``` {.sourceCode .sh}
$ sudo su - usuario_proyecto
$ cd ~
$ git clone git@gitlab.geo.gob.bo:SistemaGestionAdministrativa/ModuloPersonal.git
$ cd ModuloPersonal
```
Para instalar las dependencias del servidor
```sh ``` {.sourceCode .sh}
$ npm install
```
Para iniciar el servidor de desarrollo en el puerto 9000
``` {.sourceCode .sh}
$ grunt serve
```
Front-End
=========
**Instalando BOWER**
Bower te permite administrar los componentes que contienen HTML, CSS,
JavaScript, fuentes e incluso archivos de imagen. Bower no concatenar o
minify código o hacer cualquier otra cosa - sólo instala las versiones
correctas de los paquetes que necesita y sus dependencias.
``` {.sourceCode .sh}
$ npm install -g bower
```
**Instalando Ruby**
Un lenguaje de programación dinámico y de código abierto.
``` {.sourceCode .sh}
$ sudo apt-get install ruby-full
```
**Clonar repositorio**
``` {.sourceCode .sh}
$ sudo su - usuarioPersonal $ sudo su - usuarioPersonal
$ cd ~ $ cd ~
$ git clone git@gitlab.geo.gob.bo:SistemaGestionAdministrativa/ModuloPersonalCliente.git $ git clone git@gitlab.geo.gob.bo:SistemaGestionAdministrativa/ModuloPersonalCliente.git
$ cd ModuloPersonal $ cd ModuloPersonal
``` ```
Para instalar las dependecias del servidor Para instalar las dependencias del servidor
```sh
``` {.sourceCode .sh}
$ npm install $ npm install
``` ```
Para ara instalar las dependecias del cliente Para ara instalar las dependecias del cliente
```sh
``` {.sourceCode .sh}
$ bower install $ bower install
``` ```
Para iniciar el servidor de desarrollo en el puerto 9000 Para iniciar el servidor de desarrollo en el puerto 9000
```sh
``` {.sourceCode .sh}
$ grunt serve $ grunt serve
``` ```
## Instalacion y configuracion de servidor NGinx Servidor NGinx
==============
Servidor nginx (pronunciado en inglés “engine X”) es un servidor web/proxy inverso ligero de alto rendimiento, optimizado para aplicaciones Node.js. Servidor nginx (pronunciado en inglés “engine X”) es un servidor
web/proxy inverso ligero de alto rendimiento, optimizado para
aplicaciones Node.js.
A continuación, instalar Nginx A continuación, instalar Nginx
```sh
``` {.sourceCode .sh}
$ sudo apt-get install nginx $ sudo apt-get install nginx
``` ```
Ahora abre el archivo de configuración del bloque servidor por defecto para la edición: Ahora abre el archivo de configuración del bloque servidor por defecto
```sh para la edición:
``` {.sourceCode .sh}
$ sudo nano /etc/nginx/sites-available/default $ sudo nano /etc/nginx/sites-available/default
``` ```
Insertar la siguiente configuración. Asegúrese de sustituir su propio nombre de dominio para el server (o la dirección IP si usted no tiene un dominio configurado), y la aplicación dirección IP-Privada del servidor para el APP_PRIVATE_IP_ADDRESS . Además, cambiar el puerto ( 9000 ) si la aplicación está configurado para escuchar en un puerto diferente: Insertar la siguiente configuración. Asegúrese de sustituir su propio
```sh nombre de dominio para el server (o la dirección IP si usted no tiene un
dominio configurado), y la aplicación dirección IP-Privada del servidor
para el APP\_PRIVATE\_IP\_ADDRESS . Además, cambiar el puerto ( 9000 )
si la aplicación está configurado para escuchar en un puerto diferente:
``` {.sourceCode .sh}
server { server {
listen 80; listen 80;
...@@ -180,10 +258,16 @@ server { ...@@ -180,10 +258,16 @@ server {
} }
``` ```
Una vez que haya terminado de añadir los bloques de localización para sus aplicaciones, guardar y salir. Una vez que haya terminado de añadir los bloques de localización para
En el servidor, reiniciar Nginx: sus aplicaciones, guardar y salir. En el servidor, reiniciar Nginx:
```sh
``` {.sourceCode .sh}
$ sudo /et c/init.d/nginx restart $ sudo /et c/init.d/nginx restart
``` ```
Esto configura la web del servidor para responder a las solicitudes en su raíz. Suponiendo que nuestro servidor está disponible en example.com , el acceso a http://sitio-de-prueba.gob.bo/ a través de un navegador web que enviar la solicitud a la dirección IP privada del servidor de aplicaciones en el puerto 9000 , que se recibió y respondió a la Node.js solicitud. Esto configura la web del servidor para responder a las solicitudes en
su raíz. Suponiendo que nuestro servidor está disponible en example.com,
el acceso a <http://sitio-de-prueba.gob.bo/> a través de un navegador
web que enviar la solicitud a la dirección IP privada del servidor de
aplicaciones en el puerto 9000 , que se recibió y respondió a la Node.js
solicitud.
# modulo-personal-cliente Readme
======
Este es el cliente del modulo de personal del sistema de gestion administrativa Este es el modulo de personal pertenece al sistema de gestión
administrativa.
## Desarrolladores Equipo
- D'jalmar ------
- David
- Gustavo
### Prerequisitos **Programadores**
- [Git](https://git-scm.com/) * D'jalmar Gutierrez <dgutierrez@adsib.gob.bo>
- [Node.js and npm](nodejs.org) Node ^4.2.3, npm ^2.14.7
- [Bower](bower.io) (`npm install --global bower`)
- [Ruby](https://www.ruby-lang.org) and then `gem install sass`
- [Grunt](http://gruntjs.com/) (`npm install --global grunt-cli`)
### Para iniciar el proyecto en desarrollo se deben ejecutar los siguientes comandos en la terminal * Teodoro Nina <tnina@adsib.gob.bo>
1. Ejecutar `npm install` para instalar las dependecias del servidor.
2. Ejecutar `bower install` para instalar las dependecias del cliente. **Pasante**
* Gustavo Callejas <gcallejas@adsib.gob.bo>
Prerequisitos
-------------
- [Git]
- [Node.js and npm] Node \^4.2.3, npm \^2.14.7
- [Grunt] (`npm install --global grunt-cli`)
- [Postgresql]
Ejecución
---------
Para iniciar el proyecto en desarrollo se deben ejecutar los siguientes
comandos en la terminal
1. Ejecutar `npm install` para instalar las dependecias del servidor.
2. Ejecutar `grunt serve` para iniciar el servidor de desarrollo. Debe
iniciar automaticamente el explorador.
3. Ejecutar `grunt serve` para iniciar el servidor de desarrollo. Debe iniciar automaticamente el explorador. Compilación y Desarrollo
------------------------
## Compilacion y desarrollo Ejecutar `grunt build` para compilar el proyecto, y el resultado de esa
compilación se encuentra en la carpeta `dist` luego ejecutar **grunt
serve** para una vista previa.
Ejecutar `grunt build` para compilar el proyecto, el proyecto compilado se encuentra en la carpeta `dist` luego ejecutar `grunt serve` para una vista previa. Test
----
## Tests Ejecutar `npm test` para ejecutar todos los test(unitarios y de
integración) del proyecto
Ejecutar `npm test` para ejecutar todos los test(unitarios y de integracion) del proyecto [Git]: https://git-scm.com/
[Node.js and npm]: nodejs.org
[Grunt]: http://gruntjs.com/
[Postgresql]: http://www.postgresql.org.es/
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ModuloPersonal.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ModuloPersonal.qhc"
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/ModuloPersonal"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ModuloPersonal"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes