https://github.com/thmslfb/react-github-finder

🙍🏻A website that allows to have details on a GitHub user using his nickname
https://github.com/thmslfb/react-github-finder

github-api javascript javascript-library react vitejs

Last synced: 23 days ago
JSON representation

🙍🏻A website that allows to have details on a GitHub user using his nickname

• Host: GitHub
• URL: https://github.com/thmslfb/react-github-finder
• Owner: thmslfb
• License: mit
• Created: 2022-10-26T18:12:54.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-28T19:19:59.000Z (about 3 years ago)
• Last Synced: 2025-09-08T06:49:07.539Z (5 months ago)
• Topics: github-api, javascript, javascript-library, react, vitejs
• Language: JavaScript
• Homepage: https://thmslfb.github.io/react-github-finder/
• Size: 117 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# GitHub Finder 🔍

This is a project to test some front-end and back-end skills

I worked on this project in order to improve my knowledge of JavaScript and APIs. For this first project, I used the ReactJS library and the GitHub API. Don't hesitate to review the project in order to improve it!

## Requirements 📝

To assure that the following instructions will run on your machine, please check these following requirements: 

* Desirable node version installed >= 16.16

* Desirable npm version installed >= 8.15

## How to use it? 🤔

* Clone repo 

    ```

        git clone https://github.com/thmslfb/react-github-finder.git

    ```

* Run [`npm install`](https://docs.npmjs.com/cli/v6/commands/npm-install) into the directory that has been created after the git clone.

    * The path should look like that

        ```

        \react-github-finder

        ```

* After all the project dependencies installed successfully, run [`npm run dev`](https://nextjs.org/learn/basics/create-nextjs-app/setup)

* Open your browser and go to ```localhost:4173``` or ```localhost:5173```

After all these steps you should be good to go and work on the project!

## Author 👨‍💻 

[@thmslfb](https://github.com/thmslfb) 

## License 📜 

[MIT License](LICENSE)