-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
26 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,36 @@ | ||
# Getting Started with Create React App | ||
# GithubSearch React Application | ||
|
||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
## Overview | ||
GithubSearch is a React application that allows users to search for a GitHub user by their login name and retrieve information about the last 5 updated projects for that user. Additionally, it provides details on the last 5 commits for each project. The application utilizes the GitHub API to fetch the necessary data. | ||
|
||
## Available Scripts | ||
## Features | ||
- GitHub User Search: Enter the GitHub login name of a user to retrieve their information. | ||
|
||
In the project directory, you can run: | ||
- Project and Commit Details: View the last 5 updated projects for the user along with the last 5 commits for each project. | ||
|
||
### `npm start` | ||
- Error Handling: In case of user not found or other errors, the application provides informative error messages. | ||
|
||
Runs the app in the development mode.\ | ||
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
## Getting started | ||
|
||
The page will reload if you make edits.\ | ||
You will also see any lint errors in the console. | ||
1. Clone repository to your local machine: | ||
```bash | ||
git clone https://github.com/your-username/github-search.git | ||
``` | ||
|
||
### `npm test` | ||
2. Install dependencies using npm or yarn: | ||
|
||
Launches the test runner in the interactive watch mode.\ | ||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
```bash | ||
npm install | ||
# or | ||
yarn install | ||
``` | ||
|
||
### `npm run build` | ||
## Usage | ||
1. Enter the GitHub login name of the user you want to search for. | ||
2. Click the "Submit" button to fetch and display project and commit details. | ||
3. Explore the last 5 updated projects, including information on project updates and the last 5 commits for each project. | ||
|
||
Builds the app for production to the `build` folder.\ | ||
It correctly bundles React in production mode and optimizes the build for the best performance. | ||
|
||
The build is minified and the filenames include the hashes.\ | ||
Your app is ready to be deployed! | ||
|
||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
|
||
### `npm run eject` | ||
|
||
**Note: this is a one-way operation. Once you `eject`, you can’t go back!** | ||
|
||
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. | ||
|
||
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. | ||
|
||
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. | ||
|
||
## Learn More | ||
|
||
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
|
||
To learn React, check out the [React documentation](https://reactjs.org/). | ||
## Technologies Used | ||
- React | ||
- Axios for making API requests | ||
- Redux Toolkit for state management |