MeiProGen

MeiProGen

English | 中文

A comprehensive Vue 3 application enabling users to dynamically generate GitHub profile README files with customizable blocks.

🌟 Features

• Dynamic GitHub profile README generation
• Customizable and draggable profile blocks
• Light and dark theme support
• Multi-language support (English & Chinese)
• Real-time preview
• Internationalized Skills & Tools configuration
• Internationalized Social Media configuration

🚀 Live Demo

Check out the live demo: progen.meilingluo.cn

Preview

📁 Project Structure

MeiProGen/
├── public/
│   ├── _redirects
│   └── favicon.ico
├── src/
│   ├── assets/
│   ├── components/
│   │   └── BlockConfigs/
│   ├── router/
│   ├── stores/
│   ├── App.vue
│   └── main.ts
├── README.md
├── README-ZH.MD
└── package.json

🛠️ Tech Stack

• Vue 3 - Progressive JavaScript Framework

• TypeScript - Typed JavaScript

• Pinia - Vue Store

• Vite - Next Generation Frontend Tooling

• Marked - Markdown Parser

• Dynamic GitHub profile README generation.

• Customizable and draggable profile blocks.

• Light and dark theme support.

🏗️ Installation

# Clone the repository
git clone https://github.com/whatp/MeiProGen.git

# Navigate to the project directory
cd MeiProGen

# Install dependencies
npm install

▶️ Usage

Development

# Start the development server
npm run dev

Production

# Build for production
npm run build

# Preview the production build
npm run preview

☁️ Deployment

Vercel

1. Sign in to Vercel and create a new project
2. Link your GitHub repository and configure build settings:
   • Build Command: npm run build
   • Output Directory: dist
3. Deploy the project with default settings

Cloudflare Pages

For detailed instructions on deploying to Cloudflare Pages, please refer to our Chinese deployment guide which includes comprehensive steps for both GitHub integration and manual deployment methods.

Important Configuration for Vue Router: To ensure proper routing functionality on Cloudflare Pages, a _redirects file has been added to the public directory with the following content:

/* /index.html 200

This configuration is essential for single-page applications using Vue Router's history mode.

📊 GitHub Stats

GitHub Streak Stats

Social Stats

👥 Contributors

whatp 💻

📈 Star History

🤝 Contributing

Contributions are welcome! Here's how you can help:

1. Star the repository ⭐
2. Fork and clone locally 🍴
3. Create issues for bugs or propose new features 🐛
4. Submit pull requests with your improvements 🎉

📄 License

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

📚 中文文档

有关中文文档，请参阅 README-ZH.MD。

🙏 Acknowledgments

• Thanks to all contributors who have helped improve this project
• Inspired by the Vue.js and GitHub communities