https://github.com/techjmi/exelon
website url
https://github.com/techjmi/exelon
Last synced: 11 months ago
JSON representation
website url
- Host: GitHub
- URL: https://github.com/techjmi/exelon
- Owner: techjmi
- Created: 2025-02-15T09:41:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-15T18:41:49.000Z (over 1 year ago)
- Last Synced: 2025-04-14T18:50:58.617Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://exelon-bler.onrender.com
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub User Finder
GitHub User Finder is a React application that allows users to search for GitHub profiles and view their details along with the top 5 repositories.
## 🛠️ Tech Stack
- React (Vite)
- Axios
- Tailwind CSS
- GitHub API
- Skeleton UI with Lazy Loading
## 🗂️ Folder Structure
```
.
├── public
├── src
├── api
│ └── api.js
├── components
│ ├── SearchBar.js
│ ├── Profile.js
│ ├── Repo.js
│ ├── Error.js
│ └── Loading.js
├── App.js
├── main.jsx
└── index.css
├── .env
└── package.json
```
## ⚙️ Environment Variables
Create a `.env` file in the root directory:
```
VITE_GITHUB_TOKEN=your_github_token
```
## 🚀 Installation and Running the App
```bash
# Clone the repository
git clone https://github.com/techjmi/exelon
# Navigate to the project directory
cd exelon, client
# Install dependencies
npm install
# Start the development server
npm run dev
```
## 🧪 Features
- Search GitHub profiles by username
- Display profile details (avatar, followers, following)
- List top 5 repositories (sorted by stars)
- Skeleton loading for better UX
- Error handling for invalid users or API errors