11# GitHub Profile Preview App
22
3- A simple web application that allows users to search for GitHub profiles and view detailed information about users.
3+ A simple website that allows users to search for GitHub profiles and view detailed information about users.
4+
5+ ![ GitHub Profile Preview] ( screenshot.png )
6+
7+ ## Table of Contents
8+ - [ Features] ( #features )
9+
10+ - [ Technologies Used] ( #technologies-used )
11+ - [ Usage] ( #usage )
12+ - [ Api Information] ( #api-information )
13+ - [ Contributing] ( #contributing )
14+ - [ License] ( #license )
15+ - [ Live Demo] ( #live-demo )
416
517## Features
618
@@ -27,7 +39,7 @@ A simple web application that allows users to search for GitHub profiles and vie
2739- GitHub REST API
2840- Font Awesome for icons
2941
30- ## How to Use
42+ ## Usage
3143
32441 . Open the ` index.html ` file in your browser
33452 . Enter a GitHub username in the search box
@@ -40,8 +52,38 @@ This app uses the GitHub REST API to fetch user data. No API key is required for
4052
4153API Endpoint used: ` https://api.github.com/users/{username} `
4254
43- ## Project Structure
4455
45- - ` index.html ` - Main HTML structure
46- - ` style.css ` - CSS styling
47- - ` script.js ` - JavaScript functionality and API integration
56+
57+ ## Contributing
58+ Contributions are welcome! If you have any ideas, suggestions, or improvements, feel free to create a pull request or open an issue.
59+
60+ ### Steps to Contribute
61+ 1 . Fork the repository.
62+ 2 . Create a new branch:
63+ ``` bash
64+ git checkout -b feature/your-feature-name
65+ ```
66+ 3 . Make your changes and commit them:
67+ ``` bash
68+ git commit -m " Add your feature"
69+ ```
70+ 4 . Push to the branch:
71+ ``` bash
72+ git push origin feature/your-feature-name
73+ ```
74+ 5 . Open a pull request.
75+
76+ ### After Opening a Pull Request
77+ 1 . ** Review** : Address any feedback or change requests made by the reviewers.
78+ 2 . ** Approval** : Wait for the pull request to be approved by the maintainers.
79+ 3 . ** Merge** : Once approved, the pull request will be merged by a maintainer.
80+ 4 . ** Close** : The pull request will be closed upon merging. If not merged, it might be closed manually with an explanation.
81+ 5 . ** Cleanup** : Delete your feature branch after the pull request is merged and update your local repository.
82+
83+ ## License
84+ This project is open-source and available under the [ MIT License] ( LICENSE ) .
85+
86+ ## Live Demo
87+ You can see live at [ Link] ( https://moiz-codebyte.github.io/100-days-of-javascriptDay%20%2313%20-%20GitHub%20Profile%20Preview/ )
88+
89+ For any questions or support, please contact at [ hello@abdulmoiz.net ] ( mailto:hello@abdulmoiz.net ) .
0 commit comments