https://github.com/duduxs/github-finder

🧐 App that search github's user public data and display on web
https://github.com/duduxs/github-finder

project react

Last synced: about 2 months ago
JSON representation

🧐 App that search github's user public data and display on web

Host: GitHub
URL: https://github.com/duduxs/github-finder
Owner: Duduxs
Created: 2023-07-06T13:02:04.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2023-07-07T16:46:55.000Z (almost 3 years ago)
Last Synced: 2025-06-21T23:33:03.920Z (about 1 year ago)
Topics: project, react
Language: TypeScript
Homepage: https://edudev-github-finder.vercel.app/
Size: 274 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

Github Finder

This application was developed as a challenge in the DevSuperior bootcamp

This project is based on an application that can search github's users and show their data to the client

Technologies   |
How To Use   |
How To Contribute   |
Icon credits

Collage

## :rocket: Technologies

This project was developed with the following technologies:

- Web:

- [ReactJS](https://reactjs.org/)
- [Typescript](https://www.typescriptlang.org/)
- [React Router v5](https://github.com/ReactTraining/react-router)
- [Axios](https://github.com/axios/axios)

## :information_source: How to use
To clone and run this application, you'll need [Git](https://git-scm.com) and [Yarn](https://classic.yarnpkg.com/) installed on your computer. From your command line:

```bash
# Clone this repository
$ git clone https://github.com/duduxs/github-finder

# Go into the repository
$ cd github-finder
```

To run the frontend web:

```bash
# Install dependencies
$ yarn

# Run the app
$ yarn start
```

Now access on your browser: http://localhost:3000

## :thumbsup: How To Contribute

- Make a fork;
- Create a branch with your feature: `git checkout -b my-feature`;
- Commit changes: `git commit -m 'feat: My new feature'`;
- Make a push to your branch: `git push origin my-feature`.

## :memo: Icon credits