KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

githubProfileReadmeGenerator

★ 220 Open GitHub ↗

Generate a cool README/About me page for your Github Profile

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GitHub Profile README / About Me Generator 💯
[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)
<a href="https://www.producthunt.com/posts/github-profile-readme-generator-2?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-github-profile-readme-generator-2" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=294427&theme=light" alt="Github Profile README Generator - A Few inputs+ ~15mins= Github Profile reaches a new level 🔥 | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
[![Streamlit-Badge](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://rahulbanerjee26-githubprofilereadmegenerator---init---0nsops.streamlitapp.com/ "Go to web app")

<div align='center'>
    
## This web app lets you build a cool README for your profile.

</div>

<div align ='center'>
    
## A few inputs + ~15 mins = Your GitHub Profile reaches a new level 🔥
    
</div>

## Live 🌞

[![Go to - Live Site](https://img.shields.io/badge/Go_to-Live_Site-2ea44f?style=for-the-badge)](https://rahulbanerjee26-githubprofilereadmegenerator---init---0nsops.streamlitapp.com/)

## Article 📝

- [How to create a GitHub Profile README using this web app](https://www.realpythonproject.com/a-free-tool-to-take-your-github-profile-to-the-next-level/) on RealPythonProjet.

The article contains resources for GIFs, royalty free images/icons and tutorials on how to create your secret repo for the About Me Page, setting up the blog flow action etc.

## Usage 🔧

- Fill in the text boxes. Leave the ones you do not wish to fill blank.
- By default the generated ReadMe has GitHub stats and Wakatime stats, feel free to remove them.
- If you want to build on top of the Readme, </a> refer to the article I mentioned above </a> for resources and tips
- If you used this app to build your README, consider adding yourself to the "Users who used this app to generate a README" section. You can showcase your README and others will be able to view it and star it. You are guaranteed a star from me ⭐

## Built With 🧰

- [Python](https://github.com/python)
- [Streamlit](https://github.com/streamlit)

## Features 💿

<ul>
    <li>GIFs</li>
    <li>Social Icons</li>
    <li>Skill Icons</li>
    <li>Visitors Badge</li>
    <li>Github Stats</li>
    <li>WakaTime Stats</li>
    <li>.yml file to display Blog Posts from your feed</li>
    <li>Ability to add image banners at beginning of README</li>
    <li>Random Jokes Card</li>
</ul>

### Update 05-01-2020 🗓

- Clicking on Skills shows your github repos filtered on that skill
- Chose GitHub Stats Card Type
- Cool Image in About Me section
- Fixed styling 
- Added Default Content

### Update 07-05-2022 🗓
- Fixed Some Gif Issues
- Added Banner Images Sugesstions
- Updated Streamlit beta elements

## Running Locally 🖥️

1. Clone the repo or your fork.
1. Create a virtual environment
    ```sh
    python -m venv venv
    ```
1. Activate the virtual environment
    ```sh
    # Windows 
    venv/Scripts/activate
    
    # Linux/macOS
    source venv/bin/activate
    ```
1. Install required dependencies
    ```sh
    pip install -r requirements.txt
    ```
1. Run the App 
    ```sh
    streamlit run __init__.py
    ```

## Contributors ✨

- Rahul Banerjee - [@rahulbanerjee26](https://github.com/rahulbanerjee26) <banerjeer2611@gmail.com>
- Michael Currin - [@MichaelCurrin](https://github.com/MichaelCurrin)

## Contributing 🤝

### Feature Suggestion and Problems 💎

Go to [Issues](https://github.com/rahulbanerjee26/githubProfileReadmeGenerator/issues) on the repo.

- Create an explaining the Feature.
- If you find any errors/issues, feel free to create an Issue.

### Pull Requests 🔀

How to make code changes and add them to this repo with a Pull Request.

1. Fork the Project
1. Clone it using the URL from the Code button.
    ```sh
    git clone FORK_URL
    ```
1. Create your Feature Branch
    ```sh
    git checkout -b feat-my-feature
    ```
1. Commit your Changes
    ```sh
    git commit -m 'Add some Amazing Feature'
    ```
1. Push to the Branch
    ```sh
    git push origin feat-my-feature
    ```
1. Go to [Pull Requests](https://github.com/rahulbanerjee26/githubProfileReadmeGenerator/pulls) of the original repo.
1. Create a Pull Request. Compare across forks and pick your fork and your branch.

Once your PR is merged, I will add you as a contributor :)

Or if you wish to add yourself to 'Users who used this app' list, simply fork the repo, update the README and make a PR. Follow this format:

```markdown
- <a href = 'https://github.com/USERNAME'> DISPLAY NAME </a>
```

Or just reach out to me on Twitter/LinkedIn and I'll add you :)

To keep your fork's main branch up to date with that of the original repo, then on your fork on GitHub click the Fetch Upstream button near the top.

## Plans for future release 📆

- Adding more badges
- Giving user ability to chose between different ReadMe designs
- Increasing number of social Icons

## Users who used this app to generate a README 🌠

- <a href = 'https://github.com/rahulbanerjee26'> Rahul Banerjee </a>
- <a href = 'https://github.com/saminul'> Saminul Islam </a>
- <a href ='https://github.com/sksaikia'> Sourav Kr. Saikia </a>
- <a href ='https://github.com/brandonbartram98'> Brandon Bartram </a>
- <a href = 'https://github.com/goz4el'> Miguel Gozaine </a>

## License ⚖️

- Distributed under the `MIT License`. See [LICENSE](/LICENSE) for more information.

## Resources

- https://metrics.lecoq.io/

githubProfileReadmeGenerator

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README