Skip to content

ahkamboh/github2portfolio

Repository files navigation

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:
git clone https://github.com/yourusername/github2portfolio.git
cd github2portfolio
  1. Install dependencies:
npm install
# or
yarn install
# or
pnpm install
  1. Run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
  1. Open http://localhost:3000 with your browser to see the result.

🛠️ Built With

📝 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:

🚀 Deployment

The easiest way to deploy your GitHub2Portfolio is using the Vercel Platform.

Check out the Next.js deployment documentation for more details.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

👨‍💻 Author

Ali Hamza Kamboh

🙏 Acknowledgments

  • Thanks to @shadcn for the UI components
  • Thanks to @vercel for the deployment platform
  • Thanks to @neon for the database
  • Thanks to @lucide for the icons
  • Thanks to @nextui for the UI library

About

Transform your GitHub profile into a beautiful portfolio website. Showcase your repositories, contributions, and achievements in style.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors