GitHub Explorer App

A simple yet functional web application to explore GitHub repositories and their README content by username. Built with Next.js, React Query, React Context, and TypeScript.

✨ Features

• 🔍 Search GitHub users by username
• 📂 Display paginated list of public repositories
• 📖 View formatted README for each repository
• 🌐 Deployed to Vercel
• ⚙️ Responsive layout
• 💡 Optimized Lighthouse score
• ✅ Built with clean architecture & context-based state management

🛠️ Tech Stack

• Next.js
• TypeScript
• React Context API
• Vercel for deployment

📦 Getting Started

1. Clone this repository

git clone https://github.com/rikopernando/github-project-viewer
cd github-project-viewer

2. Install dependencies

npm install
# or
yarn

3. Set up Environment Variables

Create a .env.local file and add your GitHub Personal Access Token to increase rate limits:

NEXT_PUBLIC_GITHUB_TOKEN=your_personal_access_token

You can generate a token here (no scopes needed).

4. Run locally

npm run dev
# or
yarn dev

5. Build for production

npm run build
npm run start

🚀 Deployment

The app is deployed on Vercel. You can try it here: https://github-project-viewer-kappa.vercel.app/

📸 Screenshots

Search	Repos	README

🧪 Lighthouse Score

✅ Performance: 90+ ✅ Accessibility: 90+ ✅ Best Practices: 100 ✅ SEO: 90+

📁 Project Structure

├── apps/
├── components/
├── constants/
├── contexts/
├── hooks/
├── models/

📋 License

MIT License. © 2025 Riko