Skip to content

Commit 2bae3b9

Browse files
committed
Update index.html and README files to include GitHub Profile Preview project
1 parent 75de8a2 commit 2bae3b9

File tree

4 files changed

+54
-7
lines changed

4 files changed

+54
-7
lines changed

Day #13 - GitHub Profile Preview/README.md

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
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

3244
1. Open the `index.html` file in your browser
3345
2. 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

4153
API 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 [[email protected]](mailto:[email protected]).
74.9 KB
Loading

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@
1616

1717
## [Day #11 - Markdown Previewer](https://moiz-codebyte.github.io/100-days-of-javascript/Day%20%2311%20-%20Markdown%20Previewer/)
1818

19-
## [Day #11 - 2048 Game ](https://moiz-codebyte.github.io/100-days-of-javascript/Day%20%2312%20-%202048%20Game/)
19+
## [Day #12 - 2048 Game ](https://moiz-codebyte.github.io/100-days-of-javascript/Day%20%2312%20-%202048%20Game/)
20+
21+
## [ Day #13 - GitHub Profile Preview ](https://moiz-codebyte.github.io/100-days-of-javascript/Day%20%2313%20-%20GitHub%20Profile%20Preview/)
2022

2123
## Live Demo
2224
You can see the Projects live listing at [Link](https://moiz-codebyte.github.io/100-days-of-javascript/)

index.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@
8282
<div class="box">
8383
<a href="https://moiz-codebyte.github.io/100-days-of-javascript/Day%20%2312%20-%202048%20Game/">2048 Game </a>
8484
</div>
85+
<div class="box">
86+
<a href="https://moiz-codebyte.github.io/100-days-of-javascript/Day%20%2313%20-%20GitHub%20Profile%20Preview/">GitHub Profile Preview</a>
87+
</div>
8588
</div>
8689
</body>
8790
</html>

0 commit comments

Comments
 (0)