Skip to content

Latest commit

 

History

History
49 lines (27 loc) · 3.51 KB

README.md

File metadata and controls

49 lines (27 loc) · 3.51 KB
Raw

EN / US

Simple demonstration of the GitHub Users API

  • Hey there, welcome to my GitHub Users API web project demonstration repository! My main objective here was to enhance my skills in APIs, TypeScript, interfaces, and programming in general. In a simple and efficient manner, I developed this application using only HTML and CSS, without the need for any frameworks.

About the Project:

  • The purpose of this project is to provide an interactive and informative web application that explores the functionality of the GitHub Users API. This API is a powerful source of information about platform users, and with this project, I wanted to showcase how we can interact with it and display data in a user-friendly manner.

Key Features:

  • User Details: When searching for a user by their login, the application displays detailed information about their profile, including name, profile picture, biography, public repositories, followers, and following.

  • Responsive Design: I developed the project using pure CSS for study purposes, which ensured a better understanding of the language and an elegantly responsive layout for various screen sizes and devices.

  • TypeScript and Interfaces: To make the code safer and more readable, I wrote everything in TypeScript and used interfaces to define the structure of data coming from the GitHub API.

How to Contribute:

  • If you're interested in the project and want to contribute, feel free to fork the repository, implement improvements, fix bugs, or add new features.

Final Remarks:

  • This project is the result of my efforts to enhance my knowledge in APIs, TypeScript, interfaces, and programming in general.

PT / BR

Simples demonstração da API de Usuários do GitHub

  • E aí, seja muito bem-vindo ao meu repositório de demonstração do projeto web usando a API de usuários do GitHub! Aqui, meu objetivo principal foi aprimorar minhas habilidades em APIs, TypeScript, interfaces e programação em geral. De forma simples e eficiente, desenvolvi essa aplicação usando apenas HTML e CSS, sem a necessidade de qualquer framework.

Sobre o Projeto:

  • O objetivo deste projeto é fornecer uma aplicação web interativa e informativa que explore a funcionalidade da API de usuários do GitHub. Essa API é uma poderosa fonte de informações sobre os usuários da plataforma, e com este projeto, eu quis mostrar como podemos interagir com ela e exibir os dados de forma amigável para o usuário.

Recursos Principais:

  • Detalhes do Usuário: Ao procurar um usuário pelo login, a aplicação exibe informações detalhadas sobre o perfil, incluindo nome, foto de perfil, biografia, repositórios públicos, seguidores e seguidos.

  • Design Responsivo: Desenvolvi o projeto utilizando CSS puro para fins de estudos, o que garantiu maior apredizado sobre a linguage e um layout adaptável de maneira elegante e responsiva a diversos tamanhos de tela e dispositivos.

  • TypeScript e Interfaces: Para tornar o código mais seguro e legível, escrevi tudo em TypeScript e utilizei interfaces para definir a estrutura dos dados vindos da API do GitHub.

Como Contribuir:

  • Caso você se interesse pelo projeto e queira contribuir, fique à vontade para fazer um fork do repositório, implementar melhorias, corrigir bugs ou adicionar novos recursos.

Observações Finais:

  • Esse projeto é o resultado dos meus esforços para aprimorar meus conhecimentos em APIs, TypeScript, interfaces e programação em geral.