Skip to content

Este repositorio tiene como finalidad cumplir con un desafío laboral.

Notifications You must be signed in to change notification settings

Sevalas/github-search-tool

 
 

Repository files navigation

😁 ¡Hola!

Soy Sebastian Valencia Lasprilla y esta es mi propuesta de aplicación web que cumple con el desafío de utilizar la api de busqueda de usuarios oficial de github.

📑 Indice

    1. ¿Qué desarrollé?
    1. Características
    1. Ejecutar la aplicación en un ambiente local
    1. Generar Build del proyecto
    1. Realizar test unitarios
    1. Para ayuda futura

🔴 ¿Qué desarrollé?

Aplicación desplegada: https://github-search-tool-svl.herokuapp.com/

Esta es una aplicación desarrollada con:

  • Visual Studio Code
  • Angular
  • Node.js
  • TypeScript
  • Scss
  • Postman

Que utiliza apis de GitHub para buscar un usuario y obtener la información publica asociada a su cuenta y sus respectivos repositorios. Esta aplicación fue desarrollada para exploradores de escritorio, a pesar de no estar diseñada para otros dispositivos como tablets o celulares, el tamaño y posición de sus elementos están definidos con vh (viewport width) y vw (viewport height), por lo que no se deformaran o reposicionaran de una manera inesperada.

🔵 Características:

🔸 Esta aplicación cuenta con un componente Home

drawing

🔸 Y un componente Details

drawing

🔸 El componente Details esta dispuesto para mostrar:

drawing

  • Avatar, nombre, nickname, locación, numero de repositorios, cantidad de seguidores, cantidad de seguidos y biografía.
  • Nombre de repositorios, descripción y estrellas de calificación.
  • La busqueda de usuarios usa la Url como parametro de busqueda en donde Usuario = {username} y Url = AppRoute/user/{username}
  • Cuenta con un spinner que se muestra hasta que se obtiene la información, para dar a entender a el usuario los tiempos de carga.

🔸 Un layout para usuario inexistente

drawing

🔸 Un layout para usuario sin repositorios

drawing

🔸 Y layout para limite de busquedas:

drawing

(Este limite es el error 403 que el api genera cuando se supera el exceso de busquedas en un tiempo determinado)

⚫ Ejecutar la aplicación en un ambiente local

Esta es una aplicación que funciona con Node.Js (https://nodejs.org/es/download/) y Angular (https://cli.angular.io/)

  • Podemos obtener la aplicación clonando el repositorio con Git o descargandola directamente desde este cliente de GitHub.
  • Antes de ejecutar la aplicación debemos asegurarnos de tener las depedencias (node_modules) propias de la aplicación, esto podemos conseguirlo ejecutando el comando npm install en la ruta raiz de la aplicación.
  • Con el comando ng serve lanzaremos la aplicación en un servidor de desarrollo al que podremos acceder en http://localhost:4200/

🔴 Generar Build del proyecto

Para generar una Build de este proyecto basta con ejecutar el comando ng build en la raiz de la app.

🔵 Realizar test unitarios

Para realizar un test unitario debemos ingresar el comando ng test.

⚫ Para ayuda futura

No dudes en contactarme a traves de esta cuenta de gitHub, escribiendo algun comentario en el repositorio o escribiendo al siguiente correo: [email protected]

😃 Muchas Gracias por darle una oportunidad a mi app.

About

Este repositorio tiene como finalidad cumplir con un desafío laboral.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 57.7%
  • HTML 17.2%
  • SCSS 15.5%
  • JavaScript 9.6%