Skip to content

Latest commit

 

History

History
87 lines (65 loc) · 2.58 KB

README.md

File metadata and controls

87 lines (65 loc) · 2.58 KB

FuseColor Logo

devfinder.

REACT JS

Static Badge

DevFinder is a React-based web app that enables users to search and view GitHub profiles using the GitHub API. It provides essential details like repositories, followers, and activity, helping users connect and collaborate with developers. With a sleek, responsive design and optimized performance, DevFinder simplifies the process of exploring GitHub profiles, offering a smooth and efficient user experience.

✨ Features

  • GitHub User Search: Instantly search for GitHub users by username.
  • Profile Overview: Displays user avatar, name, bio, location, and other key profile details.
  • Real-time API Fetching: Utilizes GitHub’s API for up-to-date profile data.

🚀 Deployment

💡 Getting Started

Note: The GitHub access token is essential for accessing its REST API learn more.

  • Create a .env file in the root of the folder with the following contents:
VITE_TOKEN={your_token}

🖥️ Local Setup:

  1. Clone the repository
https://github.com/vishnu1002/dev-finder.git
cd dev-finder
  1. Install dependencies
npm install
  1. Build project
npm build
  1. Run the app locally
npm run dev

🐳 Docker Setup:

  1. Clone the repository
https://github.com/vishnu1002/dev-finder.git
cd dev-finder
  1. Build and run the container
docker-compose up -d
  1. Stop the container
docker-compose down

Credits

devfinder is developed and maintained by Vishnu

License

This project is licensed under the MIT License.

devfindersocial