Manual T Cnico Proyecto Software

Descargar como pdf o txt
Descargar como pdf o txt
Está en la página 1de 7

Escuela de Ingeniería en Computación

Carrera de Ingeniería en Computación


Proyecto de Ingeniería de Software

Manual de técnico: Scanner

Autores
PAMELA G UERRERO
J OSSELINE G UZMÁN
E STEBAN M ENA
R AQUEL P INTO

Costa Rica
May 24, 2022
1

TABLA DE CONTENIDOS
1 Instalación del sistema 3
1.1 Instalar Backend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.1 Instalar PostgreSQL . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.2 Instalar NodeJS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1.3 Instalar API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2 Instalar Frontend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2.1 Instalar Angular . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2.2 Instalar Interfaz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2

TABLA DE FIGURAS
1 Ejecución comando NPM START. . . . . . . . . . . . . . . . . . . . . . . . 5
2 Ejecución comando NG SERVE. . . . . . . . . . . . . . . . . . . . . . . . . 6
3

1 I NSTALACIÓN DEL SISTEMA


1.1 Instalar Backend
Como requisito para instalar el API es necesario NodeJS y PostgreSQL, si ya posee
este entorno de tiempo de ejecución puede saltarse la siguiente sección y pasar a la
sección de la instalación del proyecto.

1.1.1 Instalar PostgreSQL


1. Instalar el gestor de base de datos, siguiendo el siguiente comando:

sudo apt-get install postgresql postgresql-contrib

2. Clonar el repositorio de la base de datos para ejecutar los scripts necesarios, con
el siguiente comando en una ruta elegida:

git clone git@gitlab.com:jossguzman/db_proyecto_de_software.git

3. Para habilitar la gestión de las bases de datos se requiere ejecutar el siguiente


comando, por defecto se utiliza el usuario postgres:

sudo -u postgres psql;

4. Se debe asignar una contraseña al user postgres, con el siguiente comando, siendo
la palabra dentro de las comillas la contraseña a definir:

alter user postgres with password ’password’

5. Para crear y seleccionar la base de datos en la cual se definen las funciones y


tablas necesarias para el sistema, se utilizan los siguientes:

CREATE DATABASE judges;


\c judges;

6. Se utiliza el comando \i, la ruta y nombre del script sql para ejecutarlo, la ruta
debe ser la misma en la cual se clono el repositorio de la base de datos.

\i /home/ruta_del_repositorio/complete_database_script.sql;
4

1.1.2 Instalar NodeJS


1. Por defecto en algunos sistemas operativos NodeJS viene instalado por defecto,
para verificar si ya está instalado deberá de ejecutar los siguientes comandos:

nodejs -v
nodejs –-version
node -v
node –-version

2. En caso de que no esté instalado puede instalar NodeJS con el siguiente comando:

sudo apt install nodejs

3. Ya sea si se tiene NodeJS instalado de fábrica o si lo instaló con el paso anterior es


necesario instalar de igual manera el gestor de paquetes con el siguiente comando:

sudo apt install npm

4. Ya que el proyecto es compatible con diferentes versiones de NodeJS siempre es


recomendado usar la última versión estable por lo que se puede instalar con los
siguientes comandos:
sudo npm cache clean -f
sudo npm install -g n
sudo n stable

5. Después de instalar la ultima versión estable de NodeJS para comenzar a utilizarla


se require actualizar el PATH del sistema, se puede realizar con el siguiente
comando:

PATH="$PATH"

6. En caso de querer verificar que posee la última versión de NodeJS puede ejecutar
los comandos del paso 1 y comparar con la versión que se muestra en la página
oficial: https://nodejs.org/en/download/

1.1.3 Instalar API


Para instalar el repositorio que contiene el API se debe:

1. Es necesario descargar el repositiorio del proyecto con el comando:

git clone https://github.com/estebanmr99/api


5

2. Ingrese a la carpeta donde se descargó el API, el nombre de la carpeta es "API".

3. Una vez dentro de la carpeta deberá instalar los paquetes necesarios para el fun-
cionamiento del API, ejecutar el comando:

npm install

4. Para verificar la instalación puede ejecutar el proyecto con el comando:

npm start

Figura 1: Ejecución comando NPM START.

1.2 Instalar Frontend


1.2.1 Instalar Angular
Para instalar Angular CLI se debe ejecutar el siguiente comando en la terminal de
Linux:

npm install -g @angular/cli

1.2.2 Instalar Interfaz


Para instalar el repositorio que contiene la interfaz se debe:

1. Es necesario descargar el repositorio del proyecto con el comando:

git clone https://github.com/Pamgue/interfazProyecto

2. Ingrese a la carpeta (desde consola) donde se descargó la interfaz, el nombre de la


carpeta es "interfazProyecto".
6

3. Una vez dentro de la carpeta deberá ejecutar el comando:

ng build

El mismo descargará todas las dependencias que posee el proyecto.

Nota: si al ejecutar el comando anterior se presenta el error An unhandled excep-


tion occurred: Cannot find module ’@angular-devkit/build-angular/package.json’,
ejecute el comando:

npm install –save-dev @angular-devkit/build-angular

4. Finalmente, para verificar que la instalación ha funcionado, puede ejecutar el


comando:
ng serve

Figura 2: Ejecución comando NG SERVE.

También podría gustarte