Giter Club home page Giter Club logo

api-proxy's Introduction

Configuración


Descripción

El componente API Proxy, también conocido como reverse proxy, esta diseñado para operar como un punto de entrada a múltiples DID Methods, con el fin de simplificar su gestión y resolución. Esto se debe a que cada implementación de DID tiene sus propias especificaciones y dinámicas.

Tecnologías

La aplicación cuenta con las siguientes técnologias:

  • NodeJs
  • TypeScript

Arquitectura

Diagrama

Documentación

Link

Configuración de entorno local

Clonar el repositorio

  • Abrir el proyecto con el editor seleccionado
  • Abrir una terminal y ejecutar:
- cd source
- yarn
- yarn build
- yarn start

Pasos para instalar el componente en un servidor

  1. Contar con Linux vacío.
  2. Instalar el componente y sus imágenes, se encuentran Dockerhub.

Para instalar un componente desde Docker Hub en tu servidor, sigue estos pasos:

  1. Conéctate al servidor.

  2. Instala Docker en el servidor: Si aún no tienes Docker instalado en tu servidor, sigue las instrucciones para instalar Docker en tu sistema operativo. Puedes encontrar guías detalladas en la documentación oficial de Docker.

  3. Descarga la imagen del componente desde Docker Hub utilizando el comando

'docker pull'

Debes especificar el nombre completo de la imagen, que incluye el nombre del usuario o la organización en Docker Hub y el nombre de la imagen. Ejecuta el contenedor:

docker pull docker pull quarkid/api-proxy

Una vez que la imagen del componente se haya descargado en tu servidor, puedes ejecutar un contenedor utilizando el comando

'docker run'.
  1. Verifica que el contenedor esté en ejecución: Utiliza el comando docker ps para verificar que el contenedor esté en ejecución en tu servidor.

Variables de Entorno

Se tienen que configurar las mismas en el archivo /api-proxy/source/src/.env

Generales

N/A

Logs

N/A

Requerimientos de red

La aplicación debe tener conectividad a internet para comunicarse con la red y al componente api-zkSync.

Ruta de acceso

La aplicación debe tener conectividad a internet.

Licencia

Derechos de autor © 2023 Gobierno de la Ciudad de Buenos Aires

Licenciado bajo la Licencia Apache, Versión 2.0 (la "Licencia"); usted no puede utilizar este archivo excepto en cumplimiento con la Licencia. Puede obtener una copia de la Licencia en http://www.apache.org/licenses/LICENSE-2.0. A menos que lo requiera la ley aplicable o se acuerde por escrito, el software distribuido bajo la Licencia se distribuye "TAL CUAL", SIN GARANTÍAS O CONDICIONES DE NINGÚN TIPO, ya sean expresas o implícitas. Consulte la Licencia para el idioma específico que rige los permisos y limitaciones bajo la Licencia.

api-proxy's People

Contributors

pouchuluj avatar lautarorodriguez96 avatar

Watchers

 avatar

Forkers

extrimian

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.