Opus API
Tabla de contenidos
Descripción y contexto
Este es el servicio que gestiona la información de Opus.
Referencia del servicio
Requerimientos
Cómo iniciar
¿Te gustaría colaborar? A continuación se detallan los pasos a seguir para ponerse manos a la obra.
Dependencias
Preparación de ambiente de desarrollo
Para iniciar con el desarrollo es necesario hacer algunas configuraciones antes para mantener el estándar del proyecto.
Como habrá podido ver anteriormente, Visual Studio Code es el editor de texto principal utilizado en este proyecto, sin embargo, siéntase libre de utilizar cualquier editor o IDE de su preferencia.
Clonar el proyecto
Puede clonar el proyecto en cualquier directorio de su preferencia, pero recomendamos crear un directorio opus en el home de su sistema operativo.
mkdir ~/opusgit clone https://github.com/Streamelopers/opus-api.gitEn caso de tener correctamente configurada la variable de entorno del ejecutable de Visual Studio Code, puede optar por abrir el proyecto con el siguiente comando:
code opus-apiInstalación de extensiones
En caso de no utilizar Visual Studio Code, obviar este paso.
Es muy probable que al abrir el proyecto por primera vez en Visual Studio Code se le muestre una alerta como la siguiente:
Esto facilita la instalación de las extensiones que facilitarán el desarrollo durante su colaboración con este proyecto.
En caso de que no se muestra la alerta de recomendación de instalación, puede obtar por instalar dichas dependecias manualmente. Puede echarle un ojo al archivo .vscode/extensions.json.
Creación de archivo de variables de entorno
La prueba de fuego para saber si una aplicación tiene toda su configuración correctamente separada del código es comprobar que el código base puede convertirse en código abierto en cualquier momento, sin comprometer las credenciales. Por este motivo, debemos crear nuestro archivo de variables de entorno .env. Para esto, ejecutamos el siguiente comando:
cp .env.example .envSiéntase libre de cambiar las credenciales a su gusto.
Correr el proyecto
Para facilitar el incio de su colabación y evitar problemas de dependecias el proyecto implementa docker-compose.
Siéntase libre de correr el proyecto sin utilizar Docker, pero en importante saber que no podrá contar con el apoyo de la comunidad. Si no conoces Docker, puedes aprender lo básico rápidamente aquí.
Navegamos al directorio donde se encuentra el proyecto:
cd ~/opus/opus-apiEjecutamos el siguiente comando a través de npm:
npm run start:dockerEste script ejecuta el siguiente comando
docker-compose upque a su vez se alimenta del archivodocker-compose.yml.
Luego de esto, el proyecto debería iniciar en unos segundos.
Definición de recursos
Puede ver los recursos del servicio accediendo a: http://localhost:5000/swagger.
Stack de desarrollo
Servidor
- Node.js
- Nest.js Framework
- Docker
Base de datos
- Postgres
Descargo de responsabilidad
La información expuesta a través de este servicio proviene de la base de datos local.