github_users_api

This project concern github users API, The interface is fetching GitHub user by username and display user information on the profile card using gituhGitHubb API

Stars
7

Project Name : Github Users API

This project concern github users API, The interface is fetching GitHub user by username and display user information on the profile card using gituhGitHubb API

In order to achieve this project I used some resources and technologies listed below :

Here are ScreenShoots of the project

On Desktop On Mobile

Built With

  • Major languages : JavaScript (ES6 syntax), HTLM and CSS
  • Frameworks : none
  • Technologies used : Github, Git and Linters

Live Demo (not avialable)

Click Here To open the live demo

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites โ™ป๏ธ

  • A personal computer connected to the internet;
  • Have a working and updated browser.
  • Have a local version control like git installed on your computer
  • Have an account on Github, as an online/remote Version Control System
  • Code editor (Visual studio code, sublime text, notepad++, ...) installed on your computer;
  • At least basic of HTML and CSS.

Setup ๐ŸŽฐ

  • Click the me and you'll land on the pure repository;
  • click on the green (๐ŸŸข) button with Code Inscription;
  • You can choose to download the project or just clone it if you are familiar with Git and Github;
  • Follow normal step once download in your computer and use it as it's yours.

Install

  • If you are familiar with git, Run npm install to get all dependecies required to run the linters checks, otherwise use the downloaded project on your computer without testing files

Run test ๐Ÿงช

Run thes command bellow inside your git bash or command line interface..

  • npm build start : to run the project in your default web Browser
  • npx hint . : for the html codebase and use of best practices.
  • npx stylelint "**/*.{css,scss}" : for the css codebase and use of best practices. you can add
  • npx eslint . : for the JavaScript codebase and use of best practices
  • Note that you can add --fix keyword to the command for Css and/or JavaScript to make sure that you avoid all errors comming from your code editor

Author

๐Ÿ‘ค Chris Siku (Main Author)

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a โญ๏ธ if you like this project!

Acknowledgments

  • Microverse
  • Hat tip to anyone whose code was used.

๐Ÿ“ License

This project is MIT licensed.

Related Projects