A simple web application built with React and Vite that allows users to search for GitHub profiles by username or name. The app uses GitHub API for fetching profile data and Auth0 for authentication. Bootstrap is used for styling the interface.
- Search GitHub profiles by username or name
- View profile details including repositories, followers, and following
- Secure authentication with Auth0
- Responsive design with Bootstrap
Make sure you have the following installed:
-
Clone the repository:
git clone https://github.com/Sagnik-Coder24/auth0-github-api.git cd auth0-github-api -
Install dependencies:
yarn install # or npm install
-
Set up your Auth0 credentials:
- Create a
.envfile in the root directory and add the following environment variables:
VITE_AUTH0_DOMAIN=dev-your_auth0_domain VITE_AUTH0_CLIENT_ID=your_auth0_client_id
- Create a
-
Start the development server:
yarn dev # or npm run dev -
Open your browser and go to
http://localhost:5173to see the app in action.
-
Build the app for production:
yarn build # or npm run build -
Serve the production build:
yarn serve # or npm run serve
- # using your Auth0 account.
- Enter a GitHub username or name in the search bar.
- View the profile details, including repositories, followers, and following.
We welcome contributions from the community! Feel free to open issues and pull requests to suggest improvements, add new features, or fix bugs. Here’s how you can contribute:
- Fork the repository
- Create a new branch (
git checkout -b feature-branch) - Make your changes
- Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin feature-branch) - Open a pull request
If you have suggestions or feedback on how to improve this project, feel free to post them on our GitHub Issues page. We love hearing your ideas and collaborating with the community!
This project does not have any license.