Skip to content

shintarou-akao/github-profile-maker

Repository files navigation

🎨 GitHub Profile Maker

A tool to easily create beautiful GitHub profiles. Simply enter your GitHub username to generate a stunning profile markdown.

🎥 Demo

Demo

✨ Features

  • 🔄 Automatic profile information retrieval from GitHub username
  • 🎯 Multiple template options
  • 👀 Real-time preview
  • 📋 Copy and download generated markdown
  • 🌐 Multi-language support

🛠️ Tech Stack

  • ⚛️ React
  • 📘 TypeScript
  • 🎨 Tailwind CSS
  • ⚡ Vite
  • 🛣️ React Router
  • 📝 React Markdown

🛠️ Development Tools

This project was developed using:

  • Bolt - For rapid development and deployment
  • 🤖 Cursor Agent - For AI-powered development assistance

📖 Usage

  1. 🔑 Enter your GitHub username
  2. 🎯 Select a template
  3. 👀 Preview your generated profile
  4. 📋 Copy or download the markdown
  5. 📝 Paste it to your GitHub profile

🚀 Installation

# Clone the repository
git clone https://github.com/yourusername/github-profile-maker.git
cd github-profile-maker

# Install dependencies
npm install

# Start development server
npm run dev

📦 Build

npm run build

🤝 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

About

Generate GitHub profiles with your username.

Resources

License

Stars

3 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors