https://github.com/ahkamboh/github2portfolio
Transform your GitHub profile into a beautiful portfolio website. Showcase your repositories, contributions, and achievements in style.
https://github.com/ahkamboh/github2portfolio
github portfolio-website
Last synced: 12 months ago
JSON representation
Transform your GitHub profile into a beautiful portfolio website. Showcase your repositories, contributions, and achievements in style.
- Host: GitHub
- URL: https://github.com/ahkamboh/github2portfolio
- Owner: ahkamboh
- Created: 2024-11-15T18:28:27.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-05T05:36:03.000Z (about 1 year ago)
- Last Synced: 2025-04-05T06:26:09.430Z (about 1 year ago)
- Topics: github, portfolio-website
- Language: TypeScript
- Homepage: https://github2portfolio.vercel.app/
- Size: 250 KB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub2Portfolio
Transform your GitHub profile into a beautiful portfolio website. Showcase your repositories, contributions, and achievements in style.
## Features
- **GitHub Profile Integration**: Automatically fetches and displays your GitHub profile data
- **Custom Portfolio Generation**: Creates a personalized portfolio website
- **Responsive Design**: Built with a mobile-first approach
- **Modern UI**: Utilizes Geist font family and modern design principles
- **Easy Deployment**: Ready to deploy on Vercel
## Getting Started
### Prerequisites
- Node.js (v18 or higher)
- npm, yarn, or pnpm
### Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/github2portfolio.git
cd github2portfolio
```
2. Install dependencies:
```bash
npm install
# or
yarn install
# or
pnpm install
```
3. Run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## 🛠️ Built With
- [Next.js](https://nextjs.org/) - The React framework for production
- [TypeScript](https://www.typescriptlang.org/) - For type safety
- [Tailwind CSS](https://tailwindcss.com/) - For styling
- [Geist Font](https://vercel.com/font) - Typography
- [Shadcn UI](https://ui.shadcn.com/) - UI Components
## 📝 Usage
1. Visit the deployed application
2. Enter your GitHub username
3. Customize your portfolio settings
4. Generate and deploy your portfolio
## 🔧 Configuration
You can customize your portfolio by modifying `app/page.tsx`. The page auto-updates as you edit the file.
## 📚 Learn More
To learn more about the technologies used in this project:
- [Next.js Documentation](https://nextjs.org/docs) - Learn about Next.js features and API
- [Learn Next.js](https://nextjs.org/learn) - Interactive Next.js tutorial
## 🚀 Deployment
The easiest way to deploy your GitHub2Portfolio is using the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme).
Check out the [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
## 🤝 Contributing
Contributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/yourusername/github2portfolio/issues).
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 👨💻 Author
**Ali Hamza Kamboh**
- Website: [https://alihamzakamboh.com/](https://alihamzakamboh.com/)
- GitHub: [@ahkamboh](https://github.com/ahkamboh)
- LinkedIn: [@ahkamboh](https://www.linkedin.com/in/ahkamboh/)
## 🙏 Acknowledgments
- Thanks to [@shadcn](https://ui.shadcn.com/) for the UI components
- Thanks to [@vercel](https://vercel.com/) for the deployment platform
- Thanks to [@neon](https://neon.tech/) for the database
- Thanks to [@lucide](https://lucide.dev/) for the icons
- Thanks to [@nextui](https://nextui.org/) for the UI library