Skip to content

This is an application to view a github profile upon submitting a username

Notifications You must be signed in to change notification settings

Fideltodayy/Github-Cards-App

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Cards Project

Overview

The GitHub Cards project is a dynamic web application built with React that allows users to display GitHub user profiles in a visually appealing format. It leverages the GitHub API to retrieve user information and renders it in a clean, organized layout.You can preview it in the link below: https://github-cards-v1.netlify.app/ awaits further styling

Features

Profile Display: The application showcases GitHub user profiles with their avatars, names, associated companies , followers, and following counts.

Add New Cards: Users can input a GitHub username through a form, and the application dynamically fetches and displays the corresponding profile.

Styling: The project is styled with a theme inspired by GitHub's dark mode, providing a familiar and aesthetically pleasing user interface.

Technologies Used

React: The project is built using the React library, enabling the creation of a dynamic and interactive user interface.

Axios: Axios is used for making HTTP requests to the GitHub API, allowing seamless retrieval of user data.

Getting Started

Clone the Repository: Begin by cloning the GitHub Cards project repository to your local machine.

Install Dependencies: Navigate to the project directory and run npm install to install all necessary dependencies.

Start the Application: Use npm start to launch the application in your preferred web browser.

Usage

Adding a New Card:

Input a valid GitHub username in the provided form input field. Click the "Add Card" button. Viewing User Profiles:

Profiles are displayed in visually appealing cards, including avatars, names, companies, followers, and following counts.

Contributing

If you'd like to contribute to the GitHub Cards project, please follow these steps:

Fork the repository on GitHub. Create a new branch with a descriptive name. Make your changes and commit them with clear, concise messages. Push your changes to your forked repository. Submit a pull request, detailing the changes you made.

Acknowledgements

This project was inspired by the desire to create an interactive application for displaying GitHub user profiles.

License

This project is licensed under the MIT License.

About

This is an application to view a github profile upon submitting a username

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published