GitHub Profile README Generator
Transform your GitHub profile into a professsional portfolio using the profile-readme-generator tool. This tool automates the creation of dynamic profile READMEs by leveraging the GitHub GraphQL API to fetch your activity data.
Prerequisites
Create a new repository with the same name as your GitHub username. When you create this repository, GitHub recognizes it as a special profile repository. The README.md file in this repository becomes your profile's landing page.
Key Features
- Automated Data Sync: Automatically extracts your GitHub activity, repositories, and contribution metrics
- Multi-language Support: Displays contribution statistics in various languages
- Custom Sections: Add personalized sections to showcase specific information
- Configurable Templates: Choose from 20+ themes including dark mode, cyberpunk, and color schemes
- Skill Visualization: Generate radar charts displaying your technical stack
- Social Badges: Display your presence across developer platforms
- Daily Updates: Keep your profile current without manual intervention
Installation
Ensure Git and Node.js are installed on your system (nvm recommended for Node management).
# Clone the repository
git clone https://github.com/maurodesouza/profile-readme-generator
# Navigate to project directory
cd profile-readme-generator
# Install dependencies
yarn
# Start development server
yarn dev
The application will be available at http://localhost:3000.
Available Scripts
{
"dev": "Start development server on localhost:3000",
"build": "Create optimized production build",
"start": "Run production build on localhost:3000",
"test": "Execute test suite",
"lint": "Run ESLint on src directory"
}
Configuration Options
Customize your profile through the generator's configuration system:
{
"theme": "cyberpunk",
"showWakatime": true,
"showSkillsGraph": true,
"badges": [
"stackoverflow",
"medium",
"linkedin"
],
"displayRepos": [
"pinned",
"starred"
]
}
How It Works
The generator connects to GitHub's GraphQL API to retrieve your profile data including:
- Repository statistics and languaegs
- Contribution activity
- Follower count
- Activity timeline
This data populates a markdown template that updates automatically based on your GitHub activity. The automation ensures your profile remains accurate without requiring manual updates.
Theme Options
Available themes include:
- matrix: Green-on-black terminal aesthetic
- dracula: Dark theme with purple accents
- monokai: Classic syntax highlighting colors
- nord: Arctic, north-bluish color palette
- github-dark: GitHub's dark mode style
Each theme transforms the visual presentation of your statistics, skills chart, and badge display.