GitHub Contribution Showcase is a premium, real-time developer portfolio dashboard built to showcase open-source contributions. It fetches your GitHub pull requests, issues, and profile data directly from the GitHub API and presents them in a beautiful, filterable, and responsive user interface.
- 📊 Comprehensive Stats: Real-time summary of merged PRs, open PRs, ongoing issues, and solved issues.
- 🏷️ Language & Repository Aggregation: Automatically extracts contribution distribution across various programming languages and projects.
- 🔍 Advanced Filtering: Search, sort, and filter your contributions by repository, language, status, and comment count.
- ⚡ Performance-optimized: Integrates local caching for repository metadata to avoid hitting GitHub API rate limits.
- ⚙️ Configurable Token: Dynamic settings drawer to configure the target developer profile and optional Personal Access Token (PAT) securely in the browser.
- Core: React 18 (TypeScript)
- Bundler: Vite
- Styling: Modern, responsive CSS with CSS custom properties (variables)
- Icons: Lucide React
- Linter: Oxlint
Follow these steps to set up and run the project locally.
Ensure you have Node.js installed (v18+ recommended).
-
Fork & Clone the repository:
git clone https://github.com/Dasmat13/oss-portfolio.git cd oss-portfolio -
Install dependencies:
npm install
-
Start the development server:
npm run dev
Open your browser and navigate to the local URL (usually http://localhost:5173).
Contributions are welcome! Please feel free to open issues, submit pull requests, or start discussions.
- Fork this repository.
- Create your feature branch (
git checkout -b feat/my-new-feature). - Commit your changes (
git commit -m 'feat: add some feature'). - Push to the branch (
git push origin feat/my-new-feature). - Open a Pull Request.
Please make sure to review our Contributing Guide and Code of Conduct.
This project is licensed under the MIT License. See the LICENSE file for details. thanks.