Skip to content

REST API para procesar texto utilizando la API Personality Insights de IBM y almacenar el resultado en una tabla de DynamoDB.

License

Notifications You must be signed in to change notification settings

Alvarez-P/api-challenge

Repository files navigation

API Challenge

REST API para procesar texto utilizando el API Personality Insights de IBM y almacenar el resultado en una tabla de DynamoDB.

Getting Started

Estas instrucciones le proporcionarán una copia del proyecto en funcionamiento en su máquina local para fines de desarrollo y prueba. Consulte la implementación para obtener notas sobre cómo implementar el proyecto en un sistema en vivo.

Prerequisites 📋

Para el funcionamiento del proyecto es necesario:

  • Tener una cuenta de IBM Cloud
  • Contar con credenciales(API KEY y SECRET ACCESS KEY) en AWS
  • Instalar NodeJS y NPM
  • Instalar Docker y Docker-compose
  • Tener credenciales para el servicio Personality Insights. A continuación se explica el proceso.

Servicio y credenciales de Personality Insights

Crear nuestro servicio dentro de IBM Cloud. Para esto, iremos a la parte de catalogo y buscaremos Personality Insihgts.

Seleccionamos la region mas cercana, la version LITE, lo nombramos, y le agregamos los TAGS necesarios, para finalizar le daremos click en crear.

Ya que estemos dentro de la pagina principal del servicio donde encontraremos más información de como implementarlo, damos click en Service Credentials.

Click en View Credentials para verlas y copiarlas, ya que lo usaremos mas adelante (en caso de que no se haya creado de manera automatica, podemos generar una con New Credential+)

Installing ⬇️

Para usar el proyecto clone el repositorio o descarguelo:

git clone https://github.com/alvarez98/api-challenge.git

Instalar librerias

sudo npm i

Deployment 📦

Agregar las variables necesarias en un archivo .env, basado en la plantilla .env.example

PORT=
APIKEY=
URL_IBM=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=

Iniciar contenedor de DynamoDB

docker-compose up -d

Crear tabla Profile

npm run create-table-profile

Iniciar servidor

node server.js 

Built With 🛠️

Versioning 🚩

Future work 🚀

Contributors 👨‍👨‍👦

Credits ⭐

  • A template to make good README.md - Base template - PurpleBooth
  • Proceso para obtener el servicio y credenciales de Personality Insights de IBM - Isaac Carrada

Referencias 🔗

  1. IBM CLOUD
  2. AWS DynamoDB

License 📄

This project is licensed under the MIT License - see the LICENSE file for details

Made with ❤️ by Esteban Alvarez

About

REST API para procesar texto utilizando la API Personality Insights de IBM y almacenar el resultado en una tabla de DynamoDB.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published