Skip to content

Commit 995eb1b

Browse files
committedMar 11, 2024
Updated Readme
1 parent ec32895 commit 995eb1b

File tree

1 file changed

+56
-5
lines changed

1 file changed

+56
-5
lines changed
 

‎README.md

+56-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,59 @@
1-
# React + Vite
1+
# GitHub Tracker
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
GitHub Tracker is a web application built using React that allows users to track GitHub users and their repositories. Simply enter a GitHub username as an argument, and the application will display detailed information about the user, including their profile picture, name, bio, location, and a list of their repositories. The application also features pagination for easier navigation through large lists of repositories.
44

5-
Currently, two official plugins are available:
5+
## Features
66

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
7+
- **GitHub User Information**: Enter a GitHub username to view detailed information about the user, including their profile picture, name, bio, location, and a list of their repositories.
8+
- **GitHub Repository List**: The application displays a list of repositories associated with the user, including the repository name, description, language, and the number of stars and forks.
9+
- **Pagination**: Navigate through large lists of repositories with ease using the pagination feature.
10+
- **API Integration**: GitHub Tracker integrates with the GitHub API to fetch user and repository information in real-time.
11+
12+
## Live Demo
13+
14+
Check out the live demo of GitHub Tracker [here](https://githubreposfind.netlify.app/).
15+
16+
## Getting Started
17+
18+
To run GitHub Tracker locally on your machine, follow these steps:
19+
20+
1. Clone the repository:
21+
22+
```bash
23+
git clone https://github.com/your-username/github-tracker.git
24+
```
25+
26+
2. Navigate to the project directory:
27+
28+
```bash
29+
cd github-tracker
30+
```
31+
32+
3. Install dependencies:
33+
34+
```bash
35+
npm install
36+
```
37+
38+
4. Start the development server:
39+
40+
```bash
41+
npm start
42+
```
43+
44+
5. Open your web browser and visit `http://localhost:3000` to view the application.
45+
46+
## Technologies Used
47+
48+
- React
49+
- JavaScript
50+
- HTML5
51+
- CSS3
52+
53+
## Contributing
54+
55+
Contributions are welcome! Feel free to submit bug reports, feature requests, or pull requests to help improve GitHub Tracker.
56+
57+
## License
58+
59+
This project is licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)
Please sign in to comment.