Git Product home page Git Product logo

api-challenge's Introduction

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

api-challenge's People

Watchers

 avatar

Forkers

davidmendoza5

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.