GitHub Repositories Explorer is a web application that allows users to explore GitHub repositories, register, and log in using email and password, Google, and GitHub authentication. Users can view top GitHub users, a list of repositories, user profiles, and like their favorite repositories. The application is built using React and Firebase.
- Register and log in using email and password
- Sign in with Google and GitHub
- View top GitHub users
- Explore and search GitHub repositories
- Like and bookmark repositories
- View user profiles with their repositories
You can try out the live demo of GitHub Repositories Explorer here. Enjoy!
To run the project locally, you need the following prerequisites:
- Node.js and npm installed on your machine
- Firebase account and configuration
- GitHub API token for GitHub authentication
Follow these steps to set up and run the project locally:
- Clone this repository:
git clone https://github.com/CarlosAlbertoR/GHRepositories
- Navigate to the project directory:
cd GHRepositories
- Install dependencies:
npm install
- Set up Firebase:
Create a new Firebase project on the Firebase Console. Add a web app to your Firebase project and copy the configuration details. Create a .env file in the project root directory and add your Firebase configuration:
REACT_APP_FIREBASE_API_KEY='your-firebase-api-key'
REACT_APP_FIREBASE_AUTH_DOMAIN='your-firebase-auth-domain'
REACT_APP_FIREBASE_PROJECT_ID='your-firebase-project-id'
REACT_APP_FIREBASE_STORAGE_BUCKET='your-firebase-storage-bucket'
REACT_APP_FIREBASE_MESSAGING_SENDER_ID='your-firebase-messaging-sender-id'
REACT_APP_FIREBASE_APP_ID='your-firebase-app-id'
- Set up GitHub API token:
Generate a GitHub API token from your GitHub account. Add the GitHub API token to the .env file:
REACT_APP_GH_API_KEY='your-github-api-token'
- Start the application:
npm start
- Open your browser at http://localhost:3000