GitHunt
NH

NhanPhamThanh-IT/Profile-Readme-Generator

Profile README Generator is a tool that automatically generates a README for your GitHub profile. Users can fill out forms to create a complete README file in Markdown format. The app supports customization and live preview features to enhance the user experience.

deploymenteslintfront-end-developmentjavascriptmarkdownmui-materialreactjsreadme-generatorreadme-profiletemplate-projectvitejsweb-applicationweb-developmentwebsite

Profile Readme Generator: Craft Your Perfect GitHub Profile README

Light Mode Dark Mode
Background Image Background Image

Description

Your GitHub profile README is your digital storefront, showcasing your skills, projects, and personality to the developer community. Creating an engaging and informative profile README can be challenging and time-consuming. The Profile Readme Generator project simplifies this process by providing a specialized command-line tool designed to automatically generate stunning and personalized GitHub profile README.md files. Using interactive prompts and customizable templates, it helps you incorporate dynamic elements like GitHub stats, skill badges, social media links, and more, ensuring your profile stands out. Save time, impress visitors, and effectively communicate your developer identity with a professionally generated profile README.

Key Features

  • Profile-Focused Templates: Offers templates specifically designed for GitHub profile READMEs, incorporating common and popular sections.
  • Interactive CLI: Guides you through adding essential profile information: name, bio, location, social links (GitHub, Twitter, LinkedIn, etc.), portfolio/website URL.
  • Dynamic Content Integration: Facilitates easy inclusion of popular dynamic elements:
    • GitHub Stats Cards (e.g., via github-readme-stats by anuraghazra)
    • Top Languages Card
    • WakaTime Stats (if applicable)
    • Visitor Badges/Counters
    • Skill & Technology Badges (e.g., via Shields.io)
    • Latest Blog Posts (requires integration/RSS feed)
    • GitHub Activity Feed (requires integration)
  • Section Customization: Allows adding, removing, or reordering sections like:
    • Introduction / About Me
    • Skills / Technologies
    • Current Projects / Pinned Repositories
    • GitHub Stats
    • Social Links / Connect With Me
    • Support / Sponsorship Links (GitHub Sponsors, Buy Me a Coffee)
  • Theme & Style Options: Provides options to customize the appearance of elements like stats cards (themes, colors).
  • Markdown Best Practices: Generates clean, well-formatted Markdown suitable for GitHub profile display.
  • Extensibility: Potential to add support for more third-party profile widgets or data sources.
  • Configuration File Support: Pre-fill common details (like GitHub username, preferred theme) using a configuration file (e.g., .profile-readme-genrc).

Installation

Install the Profile Readme Generator using your preferred package manager or by cloning the repository.

Cloning the Repository:

# Clone from GitHub
git clone https://github.com/NhanPhamThanh-IT/Profile-Readme-Generator.git

# Navigate into the directory
cd Profile-Readme-Generator

# Install dependencies (adjust based on project's package manager)
npm install

# Build steps (if applicable)
# e.g., npm run build

# Link for global access (optional, example for npm)
# npm link

Usage

Generating your profile README is simple. Run the command, and it will guide you through the process.

Basic Interactive Mode:

The easiest way is to run the command directly. It will ask for your details interactively.

Profile-Readme-Generator

Specifying Output File:

By default, it might create PROFILE_README.md or similar. You can specify the output name (GitHub requires it to be README.md in a repository named after your username).

Profile-Readme-Generator --output README.md

Providing GitHub Username (Crucial for Stats/Links):

You'll likely need to provide your GitHub username for many features.

Profile-Readme-Generator --username YourGitHubUsername --output README.md

Using Flags for Non-Interactive Generation:

Provide details directly via flags (flags depend on implementation):

Profile-Readme-Generator --username YourGitHubUsername --name "Your Name" --bio "Your awesome bio" --linkedin your-linkedin --twitter YourTwitter --theme dark --output README.md --yes

(The --yes flag might skip confirmations)

Output Location:

Remember to save the generated README.md file inside a public repository on GitHub that has the same name as your GitHub username.

Refer to Profile-Readme-Generator --help for all available options.

Configuration

Configure the generator for repeated use or to set personal defaults.

  • Configuration File: A file like .profile-readme-genrc or config.json in your home directory or project root can store defaults.

    Example (.profile-readme-genrc in JSON):

    {
  "githubUsername": "YourGitHubUsername",
  "name": "Your Full Name",
  "socials": {
    "linkedin": "your-linkedin-profile",
    "twitter": "YourTwitterHandle",
    "website": "https://yourwebsite.com"
  },
  "statsCard": {
    "theme": "radical",
    "show_icons": true
  },
  "skills": ["JavaScript", "Python", "React", "Node.js", "Docker"],
  "skipPrompts": ["supportLinks"]
}

  • Environment Variables: Some settings might be configurable via environment variables.

    • PROFILE_README_GEN_USERNAME="YourGitHubUsername"
    • PROFILE_README_GEN_THEME="dark"

  • Key Options (Examples):

    • githubUsername: (String) Your GitHub username (essential).
    • name, bio, location: (String) Personal details.
    • socials: (Object) Key-value pairs for social media handles/URLs.
    • statsCard: (Object) Options for the GitHub stats card (theme, visibility, etc.).
    • skills: (Array of Strings) List of skills/technologies for badges.
    • theme: (String) Default theme for applicable widgets.

Check the tool's documentation for specific configuration details.

Development

Contribute to the Profile Readme Generator project!

Prerequisites:

  • Git
  • Node.js & npm OR Python & pip (depending on the implementation)
  • Any other specified core dependencies.

Setup Steps:

# 1. Clone the repository
git clone https://github.com/NhanPhamThanh-IT/Profile-Readme-Generator.git
cd Profile-Readme-Generator

# 2. Install development dependencies
# Node.js example:
npm install
# Python example:
pip install -r requirements-dev.txt

# 3. Set up pre-commit hooks (optional)
# e.g., npm run setup-hooks or pre-commit install

# 4. Build (if needed)
# e.g., npm run build

# 5. Run linters/formatters
# e.g., npm run lint or flake8 . ; black .

# 6. Run tests
# e.g., npm test or pytest

Making Changes:

  1. Create a branch: git checkout -b feature/NewProfileWidget or fix/StatsCardBug.
  2. Implement changes and add tests.
  3. Ensure tests and linters pass.
  4. Commit with clear messages.
  5. Push and open a Pull Request.

Contributing

Contributions make this tool better for everyone!

Ways to Contribute:

  1. Report Bugs: Open an issue with detailed reproduction steps.
  2. Suggest Features: Propose new widgets, integrations, or improvements via issues.
  3. Pull Requests:
    • Fork the repo.
    • Create a feature branch.
    • Make changes.
    • Commit changes.
    • Push to your branch.
    • Open a Pull Request with a clear description.

Contribution Guidelines:

  • Read the full CONTRIBUTING.md file.
  • Ensure code quality (tests, linting).
  • Keep PRs focused.
  • Participate in PR discussions.

License

This project is distributed under the terms of the MIT License.

Copyright (c) [Year] [Your Name / Organization Name]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

See the LICENSE file for the full text.

Acknowledgements

This project builds upon the work of others:

  • Core Libraries: Mention key dependencies (inquirer, commander/argparse, templating engines).
  • Inspiration & Services:
    • github-readme-stats by Anurag Hazra
    • Shields.io for badges
    • Other profile README generators or inspirational profiles.
  • Contributors: Thank you to everyone who contributes!
  • Tooling: Node.js/Python, Git, etc.

Contact

If you have any problems with this project, you can send mail to ptnhanit230104@gmail.com

Project Repository Link: https://github.com/NhanPhamThanh-IT/Profile-Readme-Generator

Reach out via email, or open an issue on GitHub for questions or bug reports.

Languages

JavaScript99.8%HTML0.2%

Contributors

NH
MIT License
Created April 20, 2025
Updated December 24, 2025
NhanPhamThanh-IT/Profile-Readme-Generator | GitHunt